First off, thank you for considering contributing to our open source projects! 👾❤️
- The best way to communicate with the team is to open an issue in this repository
- For bug reports, include steps to reproduce, expected behavior, and actual behavior
- For feature requests, explain the use case and benefits clearly
- If you find an existing issue you'd like to work on, please comment on it first and tag the team
- This allows us to provide guidance and ensures your time is well spent
- We discourage drive-by feature PRs without prior discussion - we want to make sure your efforts align with our roadmap and won't go to waste
- Fork the repository to your own GitHub account
- Create a new branch for your changes
- Follow the development instructions in the README.md
- Make your changes
- Test thoroughly
- Submit your PR
- Address one concern per PR
- Smaller PRs are easier to review and more likely to be merged quickly
- Clearly explain what the PR does and why
- When applicable, show before/after states or screenshots
- Include any relevant context for reviewers
- Reference the issue(s) your PR addresses with GitHub keywords (Fixes #123, Resolves #456)
- Follow existing code style and patterns
- Include tests for new functionality
- Ensure all tests pass
- Update documentation as needed
- Maintainers will review your PR as soon as possible
- We may request changes or clarification
- Once approved, a maintainer will merge your contribution
- We require all contributors to sign a Contributor License Agreement (CLA)
- For first-time contributors, a bot will automatically comment on your PR with instructions
- You'll need to accept the CLA before we can merge your contribution
- This is standard practice in open source and helps protect both contributors and the project
Thank you for your contributions!