Merge pull request #18 from aj3sh/community-standards

chore: added community standard documents

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,48 @@
+# Code of Conduct
+
+## Introduction
+
+This document outlines the code of conduct for contributors, maintainers, and users of the "commitlint" project. It aims to foster an inclusive and respectful community, promoting collaboration and positive interactions. By participating in this project, you are expected to adhere to this code of conduct. This code of conduct applies to all project-related spaces, including GitHub repositories, issue trackers, mailing lists, and social media platforms associated with the project.
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we, as contributors, maintainers, and users of the commitlint project, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual orientation.
+
+## Expected Behavior
+
+To create a positive and inclusive environment, we expect all participants to:
+
+1. Be respectful and considerate: Treat others with kindness, respect, and empathy, fostering a welcoming and collaborative atmosphere.
+2. Be inclusive and supportive: Welcome individuals from all backgrounds, experiences, and perspectives, ensuring everyone feels valued and heard.
+3. Be mindful of language and tone: Use inclusive language and avoid offensive or derogatory comments or personal attacks.
+4. Be constructive: Provide constructive feedback, suggestions, and criticism in a respectful manner, with the aim of improving the project and fostering growth.
+5. Be open-minded: Embrace diverse ideas, viewpoints, and approaches, encouraging healthy discussions and debates.
+6. Be accountable: Take responsibility for your actions, acknowledge and learn from mistakes, and avoid repeating harmful behavior.
+7. Respect project guidelines: Adhere to the project's technical guidelines, contribution guidelines, and licensing requirements.
+
+## Unacceptable Behavior
+
+The following behaviors are considered unacceptable and will not be tolerated within the community:
+
+1. Harassment and discrimination: Engaging in any form of harassment, discrimination, or exclusionary behavior, including but not limited to offensive comments, slurs, insults, derogatory remarks, or personal attacks.
+2. Intimidation and threats: Intimidating or threatening behavior, both online and offline, towards any participant in the community.
+3. Unwelcome advances: Making unwelcome sexual advances, inappropriate comments, or any other behavior of a sexual nature.
+4. Spam and trolling: Posting irrelevant, repetitive, or disruptive content with the intention of annoying or provoking others.
+5. Violation of privacy: Sharing personal or confidential information of others without their explicit consent.
+6. Plagiarism and intellectual property infringement: Claiming the work of others as your own, including copying code or content without proper attribution or permission.
+7. Violation of project guidelines: Repeatedly disregarding the project's technical guidelines, contribution guidelines, or licensing requirements.
+
+## Reporting and Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at [email protected] or [email protected]. All complaints will be reviewed and investigated promptly and fairly. The project maintainers are responsible for maintaining the confidentiality of the reporting individual(s).
+
+In the case of a verified violation of this code of conduct, appropriate actions will be taken, which may include:
+
+1. Educating the individual(s) involved about the code of conduct and providing guidance on acceptable behavior.
+2. Issuing warnings or temporary bans from project-related spaces.
+3. Implementing permanent bans from project-related spaces for repeated or severe violations.
+4. Reporting illegal behavior to relevant authorities if necessary.
+
+## Attribution
+
+This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) and [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/). It is licensed under the Creative Commons Attribution 4.0 International License

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve.
+title: ''
+labels: bug, help wanted
+assignees: aj3sh, sugat009
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Please provide the steps to reproduce the issue. Include code snippets or specific examples if applicable.
+
+**Expected behavior**
+Please provide a clear and concise description of your expected outcome.
+
+**Environment**
+
+-   Python version:
+-   Package version:
+-   Operating system:
+-   Any other relevant information about your environment.
+
+**Additional context**
+Please provide any additional context or information that may be helpful in understanding and resolving the issue. This can include:
+
+-   Error stack trace
+-   Error messages
+-   Log files
+-   Screenshots
+-   Any other relevant details related to the issue.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Use Case**
+Please describe the specific use case or scenario where this feature would be beneficial.
+
+**Proposed Solution**
+Please outline your proposed solution or approach for implementing this feature. Include any relevant details, such as code snippets or examples, if applicable.
+
+**Alternative Considered**
+Have you considered any alternative solutions or approaches? If so, please describe them and explain why you believe the proposed solution is the best option.
+
+**Dependencies**
+If this feature has any dependencies or requirements, please list them here.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+## Description
+
+[Provide a brief description of the changes introduced by the pull request.]
+
+## Related Issue
+
+[If your pull request is related to an existing issue, reference it here using the format "Fixes #issue_number".]
+
+## Type of Change
+
+Please mark the appropriate option below to describe the type of change your pull request introduces:
+
+-   [ ] Bug fix
+-   [ ] New feature
+-   [ ] Enhancement
+-   [ ] Documentation update
+-   [ ] Refactor
+-   [ ] Other (please specify)
+
+## Checklist
+
+-   [ ] My pull request has a clear title and description.
+-   [ ] I have used [semantic commit messages](https://seesparkbox.com/foundry/semantic_commit_messages).
+        Examples: `"fix: Fixed foobar bug"`, `"feat(accounts): Added foobar feature"`.
+-   [ ] I have added/updated the necessary documentation on `README.md`.
+-   [ ] I have added appropriate test cases (if applicable) to ensure the changes are functioning correctly.
+
+## Additional Notes
+
+[Add any additional notes or context that you think the reviewers should know about.]
+
+By submitting this pull request, I confirm that I have read and complied with the contribution guidelines of this project.

.github/SECURITY.md

@@ -0,0 +1,51 @@
+# Security Policy
+
+The 'commitlint' project is committed to maintaining the security and integrity of our software. This Security Policy outlines the steps we take to address security vulnerabilities, as well as the responsibilities of our contributors and users in reporting and resolving security-related issues.
+
+## Supported Versions
+
+We provide security updates and support for the latest stable release of the 'commitlint' package. It is important to keep your software up to date to ensure you have the latest security patches.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.0   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within the project, we encourage you to report it the maintainers immediately. Promptly reporting security issues helps us protect our users and take appropriate actions to address the vulnerability. To report a security vulnerability, please follow these steps:
+
+1. Email at [email protected] or [email protected] with a detailed description of the vulnerability. Please include the following information:
+
+   - Description of the vulnerability, including steps to reproduce if applicable
+   - Version of the commitlint package affected
+   - Any potential mitigations or workarounds
+
+2. Our security team will acknowledge your report within 3 to 7 days and provide further instructions and communication regarding the vulnerability.
+
+3. We kindly request that you do not publicly disclose the vulnerability until we have had sufficient time to address it and provide a fix. We strive to resolve security vulnerabilities promptly and will work with you to coordinate disclosure if necessary.
+
+4. Once the vulnerability is confirmed and addressed, we will release a security update in the form of a new package version. We will credit the reporter if desired.
+
+## Security Updates and Mitigations
+
+Upon receiving a security vulnerability report, our team will evaluate the issue and take appropriate actions to address it. This may include:
+
+- Developing and testing a patch or fix for the vulnerability
+- Coordinating with the reporter or other relevant parties to verify the vulnerability and its impact
+- Releasing a new version that includes the necessary security fixes
+
+We strive to provide security updates in a timely manner and communicate any necessary steps for users to upgrade to the latest secure version.
+
+## Responsible Disclosure
+
+We are committed to responsible disclosure of security vulnerabilities. Once a vulnerability has been addressed and a new package version is released, we encourage users and contributors to upgrade to the latest version to ensure they are protected.
+
+While we appreciate the efforts of security researchers and users who report vulnerabilities, we kindly request that you follow responsible disclosure practices by allowing us sufficient time to address the issue and release a fix before disclosing the vulnerability publicly.
+
+## Disclaimer
+
+The commitlint project is provided "as is," without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the package maintainers or contributors be liable for any claim, damages, or other liability arising from the use of the this commitlint project or any security-related incidents.
+
+## Contact
+
+For any questions, concerns, or additional information regarding the commitlint project's security policy, please contact us at [email protected] or [email protected].

CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## 0.1.0
+
+- Created commitlint CLI.
+- Created pre-commit configuration for `commit-msg` hook.
+- Created support for Github Actions.

CONTRIBUTING.md

@@ -25,3 +25,19 @@ Run the tests using the below command:
 ```bash
 pipenv run test
 ```
+
+## Before submitting
+
+Before submitting your Pull Request, please do the following steps:
+
+1. Add any changes you want.
+1. Add tests for the new changes.
+1. Edit documentation (`README.md`) if you have changed something significant.
+1. Commit your changes using [semantic commit message](https://seesparkbox.com/foundry/semantic_commit_messages).
+   Examples: `"fix: Fixed foobar bug"`, `"feat(accounts): Added foobar feature on accounts"`.
+
+## Other help
+
+You can contribute by spreading a word about this library.
+It would also be a huge contribution to write a short article on how you are using this project.
+You can also share your best practices with us.