First off, thank you for considering contributing to TWA. It's people like you that make TWA such a great tool.
- Beginner: If you're new to the project and want to help, start by checking out the issues labeled good first issue. These are typically simpler tasks that are great for first-timers.
- Experienced: If you're familiar with the project and are looking for a challenge, look for issues labeled help wanted.
- Reporting Bugs: If you find a bug, please search the issues to see if it has already been reported. If not, open a new issue with a descriptive title and clear description.
- Suggesting Enhancements: If you have an idea to improve the project, open a new issue. Be as clear and descriptive as possible.
- Code Contributions: If you'd like to contribute code (whether to fix a bug, add a new feature, or otherwise), fork the repository, make your changes, and submit a pull request.
- Fork the Repository: If you're not sure how to do this, there's a button in the top right corner of the GitHub page that says "Fork".
- Clone Your Fork: Once you've forked the repository, you can clone it to your local machine and begin making changes.
- Commit Your Changes: Make sure to write clear, concise commit messages that explain the purpose and context of your changes.
- Push to Your Fork: Once you're ready, push your changes to your fork on GitHub.
- Submit a Pull Request: Go to the main repository's page, and you should see a button that says "New pull request". Click it, compare your fork, and submit the request.
- Comments: Comment your code where necessary. This helps others understand the purpose and functionality of your code.
- Variable Naming: Use descriptive variable names that convey the purpose of the variable.
Please adhere to the coding conventions used throughout the project. If the project uses a linter or has a style guide, make sure your contributions respect them.
- Regression Tests: Ensure that your changes don't break existing functionality.
- Add Test Cases: For new features, add test cases to cover the new functionality.
Ensure that your code includes adequate tests if applicable and that all tests pass before submitting a pull request.
- Inline Documentation: For complex code snippets, provide inline documentation.
- User Guide Updates: If your changes affect how users interact with the project, update the user guide accordingly.
- Join Meetings: Participate in regular community meetings to stay updated and share your insights.
- Mentorship: Consider mentoring new contributors. Sharing your expertise can help grow and strengthen the community.
- Act on Review Feedback: When your pull request is reviewed, there might be feedback or changes requested. Act on this feedback promptly.
- Review Others' PRs: Reviewing others' pull requests can give you a new perspective and help you understand the project better.
- Acknowledge Others: If you used someone's code or idea, give them credit.
- Celebrate Success: Celebrate when your pull request gets merged or when you achieve a significant contribution milestone.
Make sure to regularly pull from the main repository to keep your fork up-to-date with the latest changes. This will help avoid merge conflicts.
If you're unsure about something or need assistance, don't hesitate to ask. Reach out on our community chat or discussion forums.
Please read and follow our Code Of Conduct to ensure our community remains welcoming and respectful to all contributors.