diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ea54cc6 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,34 @@ +# Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we, as contributors and maintainers, pledge to make participation in our project and 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 identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +- Using welcoming and inclusive language. +- Being respectful of differing viewpoints and experiences. +- Gracefully accepting constructive criticism. +- Focusing on what is best for the community. +- Showing empathy towards other community members. + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances. +- Trolling, insulting/derogatory comments, and personal or political attacks. +- Public or private harassment. +- Publishing others' private information, such as a physical or electronic address, without explicit permission. + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..aa2d89b --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,62 @@ +# Contributing Guidelines + +Thank you for considering contributing to our project! We appreciate your time and effort. + +## Getting Started + +1. Fork the repository. + +2. Clone the forked repository to your local machine. + + ```bash + git clone https://github.com/your-username/repository.git + ``` + +3. Create a new branch for your feature or bug fix. + + ```bash + git checkout -b feature-branch + ``` + +4. Make your changes and test thoroughly. + +5. Commit your changes. (Use Conventional Commits.) + + ```bash + git commit -m "feat: added foo bar baz" + ``` + +6. Push to the branch. + + ```bash + git push origin feature-branch + ``` + +7. Open a pull request with a clear title and description. + +## Style Rules + +Please follow the coding style and conventions used in the project. This project uses [Conventional Commits](https://conventionalcommits.org) for commit messages and Prettier for code formatting. + +> [!IMPORTANT] +> Don't take the rules too seriously. It's just a guideline. + +## Submitting a Pull Request + +- Fill out the provided pull request template with all relevant details. +- Ensure your code is well-documented. +- Make sure all tests pass before submitting the pull request. + +## Reporting Issues + +If you encounter any issues with the project: + +1. Check if the issue has already been reported. +2. If not, create a new issue with a clear title and description. +3. Include steps to reproduce the issue if possible. + +## Help and Support + +If you need help or have questions, feel free to reach out via social links or create an issue. + +Thank you for contributing to our project!