Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.
Some guidelines to help you contribute effectively:
- Include screenshots for visual changes.
- Provide a detailed description in your Pull Request—leave nothing ambiguous for the reviewer.
- Review your code first. Comment on complex or noteworthy code for the reviewer.
- Maintain clear communication. Whether in an issue or a pull request, keep discussions open and informative.
See README.
We actively welcome your pull requests. Linking to an existing issue is preferred.
- Fork the repo and create your branch from
mainor the designated default branch. - Use descriptive branch names like
feature/{issue-number}-add-new-thing - Add tests for new code where applicable.
- Update documentation for API changes.
- Include screenshots for visual changes.
- Ensure the test suite passes.
- Resolve any lint warnings.
- Indicate improvements to existing code in your PR description.
- PR titles should begin with "feat:" or "fix:".
- Link your work to an existing issue. PRs without a linked issue will be closed.
Note: All pull requests need a label for automation. Follow this template for guidance.
Example titles:
- fix: Correct typo in chatbot response.
- feat: Add support for voice commands.
- refactor!: Improve data fetching efficiency.
Refer to Conventional Commits for more examples.
Use GitHub's draft pull request feature to indicate ongoing work. This will disable the merge button until the PR is ready.
To contribute based on an open issue, assign yourself by commenting .take. Unassigned issues are open for contribution—assign yourself to avoid conflicts.
For first-time contributors, consider starting with issues labeled bug or good first issue.
All questions are welcome.
By contributing to this project, you agree to license your contributions under the MIT license.