Thank you for your interest in contributing to Your Project Name! We welcome both bug reports and pull requests.
- Search Existing Issues: Before reporting a bug, please check if it has already been reported.
- Provide Detailed Information: Include steps to reproduce the bug, expected behavior, and actual behavior.
- Include Screenshots: Visuals can help in understanding the issue better.
- Search for Existing Suggestions: Ensure your idea hasn't been suggested already.
- Describe the Enhancement: Explain the improvement and its benefits.
-
Fork the Repository: Click the "Fork" button at the top right of the repository page.
-
Create a Feature Branch:
git checkout -b feature/your-feature-name ``` -
Commit Your Changes:
git commit -m "Add your commit message here" ```
-
Push to the Branch:
git push origin feature/your-feature-name ``` -
Create a Pull Request: Navigate to the repository on GitHub and click "Compare & pull request."
-
Linting: Ensure your code passes all linting checks by running:
npm run lint ``` -
Testing: Write tests for your changes and ensure all tests pass:
npm test ```
All pull requests are subject to review by project maintainers. Please be patient and address any feedback provided.
By contributing, you agree that your contributions will be licensed under the MIT License.