feat: merge with main

montasim · Aug 13, 2024 · d64421a · d64421a
2 parents 9dfe007 + 4e9e8be
commit d64421a
Show file tree

Hide file tree

Showing 3 changed files with 145 additions and 11 deletions.
diff --git a/CLA.md b/CLA.md
@@ -0,0 +1,90 @@
+[//]: # 'CONTRIBUTOR LICENSE AGREEMENT'
+
+# <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=24&duration=1&pause=1&color=EB008B&center=true&vCenter=true&repeat=false&width=500&height=40&lines=CONTRIBUTOR+LICENSE+AGREEMENT+(CLA)" alt="CONTRIBUTOR LICENSE AGREEMENT (CLA)" />
+
+Thank you for your interest in contributing to our project! To ensure that our project remains sustainable and that contributions can be integrated smoothly, we require all contributors to agree to the following Contributor License Agreement ("Agreement"). This Agreement helps us maintain the quality and integrity of the project while respecting your rights as a contributor.
+
+## Table of Contents
+
+1. [Definitions](#1-definitions)
+2. [License Grant](#2-license-grant)
+3. [Original Work](#3-original-work)
+4. [No Obligation to Use](#4-no-obligation-to-use)
+5. [Contribution Process](#5-contribution-process)
+6. [Support and Warranties](#6-support-and-warranties)
+7. [Security Policy](#7-security-policy)
+8. [Governing Law](#8-governing-law)
+9. [Miscellaneous](#9-miscellaneous)
+
+## 1. Definitions
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=140&height=40&lines=1.+Definitions" alt="1. Definitions" />'
+
+-   **"You" (or "Your")**: This refers to the individual or legal entity submitting the Contribution.
+-   **"Contribution"**: Any code, documentation, or other material you submit to this project.
+-   **"Project"**: The open-source project to which you are contributing.
+-   **"Maintainers"**: The current maintainers of the Project.
+
+## 2. License Grant
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=180&height=40&lines=2.+License+Grant" alt="2. License Grant" />'
+
+By submitting a Contribution to the Project, You hereby grant to the Maintainers a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable license to:
+
+-   Reproduce, prepare derivative works of, publicly display, publicly perform, and distribute your Contributions.
+-   Incorporate your Contributions into the Project, whether in whole or in part.
+-   Sublicense these rights to others to promote, distribute, and further develop the Project.
+
+## 3. Original Work
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=185&height=40&lines=3.+Original+Work" alt="3. Original Work" />'
+
+You represent and warrant that:
+
+-   You are legally entitled to grant the above license.
+-   The Contributions are your original creation or you have obtained the necessary permissions to make the Contributions.
+-   The Contributions do not violate any third-party intellectual property rights.
+
+## 4. No Obligation to Use
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=260&height=40&lines=4.+No+Obligation+to+Use" alt="4. No Obligation to Use" />'
+
+The Maintainers are under no obligation to accept or use your Contributions. Contributions may be declined or accepted at the sole discretion of the Maintainers.
+
+## 5. Contribution Process
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=265&height=40&lines=5.+Contribution+Process" alt="5. Contribution Process" />'
+
+By contributing to this Project, you agree to follow the [CONTRIBUTION](CONTRIBUTION.md) guidelines, including:
+
+-   Adhering to the [Conventional Commit Messages](https://gist.github.com/montasim/694610e53305bab2cf9070004bef81e6) standard.
+-   Following our [coding style guide](CONTRIBUTION.md#guidelines) as defined in the Project’s `.prettierrc` and `eslint.config.mjs`.
+-   Participating in the [code review process](CONTRIBUTION.md#code-review-process).
+
+## 6. Support and Warranties
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=300&height=40&lines=6.+Support+and+Warranties" alt="6. Support and Warranties" />'
+
+You acknowledge that your Contributions are provided on an "AS IS" basis, without warranties of any kind, express or implied, including but not limited to warranties of merchantability or fitness for a particular purpose.
+
+## 7. Security Policy
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=190&height=40&lines=7.+Security+Policy" alt="7. Security Policy" />'
+
+By contributing to this Project, you agree to follow the guidelines set forth in our [SECURITY POLICY](SECURITY.md) for responsibly disclosing any security vulnerabilities.
+
+## 8. Governing Law
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=195&height=40&lines=8.+Governing+Law" alt="8. Governing Law" />'
+
+This Agreement shall be governed by and construed in accordance with the laws of [Bangladesh](), without regard to its conflict of laws principles.
+
+## 9. Miscellaneous
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=190&height=40&lines=9.+Miscellaneous" alt="9. Miscellaneous" />'
+
+-   **Entire Agreement**: This Agreement constitutes the entire agreement between the parties concerning its subject matter and supersedes all prior agreements and understandings.
+-   **Amendments**: This Agreement may only be amended by a written instrument signed by both parties.
+-   **Severability**: If any provision of this Agreement is found to be invalid or unenforceable, the remaining provisions shall remain in full force and effect.
+
+**By submitting a Contribution to this Project, you agree to the terms of this Contributor License Agreement.**
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
@@ -2,7 +2,18 @@
 
 First off, thank you so much for considering a contribution to our project. We welcome contributions from everyone!
 
-## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=245&height=40&lines=How can I contribute?" alt="How can I contribute?" />
+## Table of Contents
+
+-   [1. How can I contribute?](#1-how-can-i-contribute)
+-   [2. Guidelines](#2-guidelines)
+    -   [2.1 Git commit messages](#21-git-commit-messages)
+    -   [2.2 Coding style guide](#22-coding-style-guide)
+-   [3. Code Review Process](#3-code-review-process)
+-   [4. Community and Communication](#4-community-and-communication)
+
+## 1. How can I contribute?
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=245&height=40&lines=How can I contribute?" alt="How can I contribute?" />'
 
 Contributing is simple. Here's how you can do it:
 
@@ -23,13 +34,19 @@ Contributing is simple. Here's how you can do it:
     ```
 10. **Submit a Pull Request**: Go to your repository on GitHub and click the 'Compare & pull request' button. Fill in the details and submit.
 
-## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=120&height=40&lines=Guidelines" alt="Guidelines" />
+## 2. Guidelines
+
+[//]: # '## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=120&height=40&lines=Guidelines" alt="Guidelines" />'
 
-### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=202&height=40&lines=Git+commit+messages" alt="Git commit messages" />
+### 2.1 Git commit messages
+
+[//]: # '### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=202&height=40&lines=Git+commit+messages" alt="Git commit messages" />'
 
 We adhere to the [Conventional Commit Messages](https://gist.github.com/montasim/694610e53305bab2cf9070004bef81e6) standard to maintain a clear history.
 
-### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=172&height=40&lines=Coding+style+guide" alt="Coding style guide" />
+### 2.2 Coding style guide
+
+[//]: # '### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=172&height=40&lines=Coding+style+guide" alt="Coding style guide" />'
 
 We use [ESLint](https://eslint.org/docs/latest/use/getting-started) integrated with [Prettier](https://github.com/prettier/eslint-plugin-prettier) to enforce a consistent code style. Ensure your submissions are compliant by running ESLint checks locally:
 
@@ -117,10 +134,14 @@ We use [ESLint](https://eslint.org/docs/latest/use/getting-started) integrated w
     };
     ```
 
-### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=195&height=40&lines=Code+Review+Process" alt="Code Review Process" />
+## 3. Code Review Process
+
+[//]: # '### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=195&height=40&lines=Code+Review+Process" alt="Code Review Process" />'
 
 All submissions, including submissions by project maintainers, require review. We use GitHub pull requests for this process. The core team members review the pull requests regularly and provide feedback. We aim to respond to pull requests within one week. If your pull request is particularly urgent, please mention this in the request.
 
-### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=310&height=40&lines=Community+and+Communication" alt="Community and Communication" />
+## 4. Community and Communication
+
+[//]: # '### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5¢er=true&vCenter=true&repeat=false&width=310&height=40&lines=Community+and+Communication" alt="Community and Communication" />'
 
 Follow discussions in the [GitHub Issues](https://github.com/{username}/{repo}/issues) section of our repository.
diff --git a/SECURITY.md b/SECURITY.md
@@ -1,12 +1,27 @@
+[//]: # (SECURITY POLICY)
+
 # <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=24&duration=1&pause=1&color=EB008B&center=true&vCenter=true&repeat=false&width=210&height=40&lines=SECURITY+POLICY" alt="SECURITY POLICY" />
 
 
-## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=210&height=40&lines=Security+Overview" alt="Security Overview" />
+## Table of Contents
+
+- [Security Overview](#1-security-overview)
+- [Reporting a Vulnerability](#2-reporting-a-vulnerability)
+- [What to Expect After Reporting](#3-what-to-expect-after-reporting)
+- [Security Response Process](#4-security-response-process)
+- [Contact Information](#5-contact-information)
+
+
+## 1. Security Overview
+
+[//]: # (## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=210&height=40&lines=Security+Overview" alt="Security Overview" />)
 
 We are committed to ensuring the security of our users and prioritize the confidentiality, integrity, and availability of our systems and services. This document provides guidelines on how to report security vulnerabilities and outlines our response process.
 
 
-## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=285&height=40&lines=Reporting+a+Vulnerability" alt="Reporting a Vulnerability" />
+## 2. Reporting a Vulnerability
+
+[//]: # (## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=285&height=40&lines=Reporting+a+Vulnerability" alt="Reporting a Vulnerability" />)
 
 If you discover a security vulnerability in our service, please follow the steps below to report it responsibly:
 
@@ -18,13 +33,18 @@ If you discover a security vulnerability in our service, please follow the steps
   - Any other relevant information (e.g., operating system, library versions).
 
 
-### <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=300&height=40&lines=What+to+Expect+After+Reporting" alt="What to Expect After Reporting" />
+## 3. What to Expect After Reporting
+
+[//]: # (## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=18&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=300&height=40&lines=What+to+Expect+After+Reporting" alt="What to Expect After Reporting" />)
 
 - **Acknowledgment**: We aim to acknowledge receipt of your report within 24 hours.
 - **Communication**: We will maintain open and transparent communication with you to discuss the findings.
 - **Timeline**: While the response time can vary based on the complexity of the report and existing priorities, we strive to assess and respond to all reports within one week.
 
-## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=300&height=40&lines=Security+Response+Process" alt="Security Response Process" />
+
+## 4. Security Response Process
+
+[//]: # (## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=300&height=40&lines=Security+Response+Process" alt="Security Response Process" />)
 
 Upon receiving a security report, we follow a standard procedure to evaluate and mitigate the issue:
 
@@ -34,7 +54,10 @@ Upon receiving a security report, we follow a standard procedure to evaluate and
 4. **Release**: Deploy the fixes and notify all stakeholders.
 5. **Disclosure**: After mitigating the risk, we will work with the reporter to publicly disclose the vulnerability in a responsible manner.
 
-## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=230&height=40&lines=Contact+Information" alt="Contact Information" />
+
+## 5. Contact Information
+
+[//]: # (## <img loading="lazy" src="https://readme-typing-svg.demolab.com?font=Poppins&weight=700&size=22&duration=1&pause=1&color=00B8B5&center=true&vCenter=true&repeat=false&width=230&height=40&lines=Contact+Information" alt="Contact Information" />)
 
 For further inquiries or suggestions regarding our security policy, please contact us at [montasimmamun@gmail.com](mailto:montasimmamun@gmail.com).