diff --git a/CLA.md b/CLA.md index 646f1b2..754620b 100644 --- a/CLA.md +++ b/CLA.md @@ -4,6 +4,8 @@ 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) @@ -16,18 +18,22 @@ Thank you for your interest in contributing to our project! To ensure that our p 8. [Governing Law](#8-governing-law) 9. [Miscellaneous](#9-miscellaneous) -## 1. Definitions +
+ +[//]: # '## 1. Definitions' -[//]: # '## 1. Definitions' +## 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 +
+ +[//]: # '## 2. License Grant' -[//]: # '## 2. License Grant' +## 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: @@ -35,9 +41,11 @@ By submitting a Contribution to the Project, You hereby grant to the Maintainers - 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 +
-[//]: # '## 3. Original Work' +[//]: # '## 3. Original Work' + +## 3. Original Work You represent and warrant that: @@ -45,15 +53,19 @@ You represent and warrant that: - 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 +
+ +[//]: # '## 4. No Obligation to Use' -[//]: # '## 4. No Obligation to Use' +# 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 +
-[//]: # '## 5. Contribution Process' +[//]: # '## 5. Contribution Process' + +## 5. Contribution Process By contributing to this Project, you agree to follow the [CONTRIBUTION](CONTRIBUTION.md) guidelines, including: @@ -61,27 +73,35 @@ By contributing to this Project, you agree to follow the [CONTRIBUTION](CONTRIBU - 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 +
+ +[//]: # '## 6. Support and Warranties' -[//]: # '## 6. Support and Warranties' +## 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 +
+ +[//]: # '## 7. Security Policy' -[//]: # '## 7. Security Policy' +## 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 +
-[//]: # '## 8. Governing Law' +[//]: # '## 8. Governing Law' + +## 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 +
+ +[//]: # '## 9. Miscellaneous' -[//]: # '## 9. Miscellaneous' +## 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. diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 0d1b341..1c1f15e 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -2,6 +2,8 @@ First off, thank you so much for considering a contribution to our project. We welcome contributions from everyone! +
+ ## Table of Contents - [1. How can I contribute?](#1-how-can-i-contribute) @@ -11,9 +13,11 @@ First off, thank you so much for considering a contribution to our project. We w - [3. Code Review Process](#3-code-review-process) - [4. Community and Communication](#4-community-and-communication) -## 1. How can I contribute? +
+ +[//]: # '## 1. How can I contribute?' -[//]: # '## How can I contribute?' +## 1. How can I contribute? Contributing is simple. Here's how you can do it: @@ -34,19 +38,21 @@ 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. -## 2. Guidelines +
+ +[//]: # '## 2. Guidelines' -[//]: # '## Guidelines' +## 2. Guidelines -### 2.1 Git commit messages +[//]: # '### 2.1 Git commit messages' -[//]: # '### Git commit messages' +### 2.1 Git commit messages We adhere to the [Conventional Commit Messages](https://gist.github.com/montasim/694610e53305bab2cf9070004bef81e6) standard to maintain a clear history. -### 2.2 Coding style guide +[//]: # '### 2.2 Coding style guide' -[//]: # '### Coding style guide' +### 2.2 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: @@ -134,14 +140,18 @@ We use [ESLint](https://eslint.org/docs/latest/use/getting-started) integrated w }; ``` -## 3. Code Review Process +
-[//]: # '### Code Review Process' +[//]: # '## 3. Code Review Process' + +### 3. 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. -## 4. Community and Communication +
+ +[//]: # '## 4. Community and Communication' -[//]: # '### Community and Communication' +### 4. 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 index a2ab8ee..3b57046 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,26 +2,22 @@ # SECURITY POLICY +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. -## 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 +
-[//]: # (## Security Overview) +## Table of Contents -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. +1. [Reporting a Vulnerability](#1-reporting-a-vulnerability) +2. [What to Expect After Reporting](#2-what-to-expect-after-reporting) +3. [Security Response Process](#3-security-response-process) +4. [Contact Information](#4-contact-information) +
-## 2. Reporting a Vulnerability +[//]: # (## 1. Reporting a Vulnerability) -[//]: # (## Reporting a Vulnerability) +## 1. Reporting a Vulnerability If you discover a security vulnerability in our service, please follow the steps below to report it responsibly: @@ -32,19 +28,21 @@ If you discover a security vulnerability in our service, please follow the steps - Potential impact of the vulnerability. - Any other relevant information (e.g., operating system, library versions). +
-## 3. What to Expect After Reporting +[//]: # (## 2. What to Expect After Reporting) -[//]: # (## What to Expect After Reporting) +## 2. 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. +
-## 4. Security Response Process +[//]: # (## 3. Security Response Process) -[//]: # (## Security Response Process) +## 3. Security Response Process Upon receiving a security report, we follow a standard procedure to evaluate and mitigate the issue: @@ -54,10 +52,11 @@ 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. +
-## 5. Contact Information +[//]: # (## 4. Contact Information) -[//]: # (## Contact Information) +## 4. Contact Information For further inquiries or suggestions regarding our security policy, please contact us at [montasimmamun@gmail.com](mailto:montasimmamun@gmail.com).