CONTRIBUTION.md

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?
• 2. Guidelines
  • 2.1 Git commit messages
  • 2.2 Coding style guide
• 3. Code Review Process
• 4. Community and Communication

Contributing is simple. Here's how you can do it:

1. Identify an Issue: Look for existing Issues or create your own explaining the feature or fix.
2. Fork the Repository: Click on the fork button in the top right corner.
3. Clone the Repository: After forking, clone the repo to your local machine to make changes.
4. Set up Your Environment: Set up the repository by following the instructions in the setup section of the README.md.
5. Create a New Branch: Before making any changes, switch to a new branch:

   git checkout -b your-new-branch-name
   

6. Make Changes: Implement your feature or fix.
7. Run Tests: Ensure your changes do not break any existing functionality.
8. Write Commit Messages: Follow the Conventional Commit Messages format.
9. Push to GitHub: After committing your changes, push them to GitHub:

   git push origin your-new-branch-name
   

10. Submit a Pull Request: Go to your repository on GitHub and click the 'Compare & pull request' button. Fill in the details and submit.

We adhere to the Conventional Commit Messages standard to maintain a clear history.

We use ESLint integrated with Prettier to enforce a consistent code style. Ensure your submissions are compliant by running ESLint checks locally:

1. .prettierrc
2. eslint.config.mjs

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.

Follow discussions in the GitHub Issues section of our repository.