Contributing to BeeWare Docs Tools

TODO: MAKE SURE THIS IS COMPLETE

TODO: Intro

Can I contribute?

Yes! We have opportunities for folks at every experience level to contribute. Whether this is your first time contributing to open source, or you've been doing it for years, we have something that will work for you.

Is this your first time contributing to an open source project? We're here to help! We have advice for first-time contributors to help with getting past any initial fears and concerns.

What can I do?

Triage an issue

If an issue has no comments from anyone other than the original reporter, it needs to be triaged. Triaging an issue involves taking the information provided by the reporter, and trying to reproduce it.

Fix an issue

Once the source of an issue is identified, the next step is to resolve it. You'll need to work through the process of fixing an issue.

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.

Implement a new feature

Do you have a design in mind for your proposed feature, or have you found an existing feature issue that interests you? You canimplement a new feature.

Add documentation

No feature is complete until it's well documented. Writing documentation is a way to contribute that doesn't necessarily involve writing code.

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 by reproducing the issue.

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 documentation, you'll need to build the docs.

Write documentation

To contribute documentation, you'll write new content or update existing content.

Submit a pull request

Once your changes are ready, you'll submit a pull request for review.

Translate

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.