Contribution guide¶
There are plenty of ways to contribute to BeeWare. These guides cover everything you need to know to provide your contribution.
What can I do?¶
Fix an issue¶
The most obvious contribution you can make is to write code to fix a known issue.
Implement a new feature¶
Is BeeWare missing a feature that you'd like to see? You can implement a new feature.
Write documentation¶
No feature is complete until it's well documented. Writing documentation is a way to contribute that doesn't involve writing code.
Triage an issue¶
Every time someone reports a new issue, that issue needs to be triaged. Triaging an issue involves taking the information provided by the reporter, and trying to reproduce the problem they describe.
Review a pull request¶
Once a pull request is submitted, it needs to be reviewed before it can be merged. Regardless of whether you are deeply familiar with the content, there is likely a way you can help with reviewing a pull request.
Suggest a new feature¶
Do you have a suggestion or idea for a new addition to one of the BeeWare tools? You can propose a new feature for consideration.
Translate content¶
BeeWare maintains various documentation in multiple languages. If you know a language other than English, you can help with translating content.
Use the tools¶
Do you have an idea for an app built with Toga? Do you have an existing app that could be packaged with Briefcase? You can use the tools and provide feedback on your experience.
How do I contribute?¶
Set up a development environment¶
Before you can begin contributing to BeeWare, you'll need to set up your development environment.
Reproduce an issue¶
Before fixing an issue, you'll need to verify it exists. Reproducing an issue is also an important part of triage.
Work from a branch¶
When preparing to submit a contribution, always work from a branch.
Avoid scope creep¶
It's important to maintain focus, and avoid scope creep with your contribution.
Propose a new feature¶
You'll follow these steps to propose a new feature.
Write, run, and test code¶
To update or contribute code, you'll need to write, run, and test your code.
Build documentation¶
To update or contribute to documentation, you'll need to be able to build the docs.
Write documentation¶
To contribute documentation, you'll write new content or update existing content.
Add a change note¶
Every pull request should be accompanied by a change note.
Submit a pull request¶
Once your changes are ready, you'll submit a pull request for review.
Provide a review¶
If you're comfortable, you can provide a review of someone else's contribution.
Translate content¶
BeeWare uses Weblate for translations, which requires a few steps to get started.
Submit a new issue¶
If you run into a new problem or bug, it's helpful to submit an issue.
What happens next?¶
Pull request review¶
When a pull request is submitted, the next step is the PR review.
The release process¶
Merged contributions will go through the release process.
Style Guides¶
Code style guide¶
These are the guidelines for contributing code to BeeWare projects.
Documentation style guide¶
These are the guidelines for contributing documentation to BeeWare projects.