Contributor's Guide¶

Code of Conduct¶

The Python community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences great successes and continued growth. When you’re working with members of the community, follow the Python Software Foundation Code of Conduct to help steer your interactions and keep Python a positive, successful, and growing community.

Get Early Feedback¶

If you are contributing, do not feel the need to sit on your contribution until it is perfectly polished and complete. It helps everyone involved for you to seek feedback as early as you possibly can. Submitting an early, unfinished version of your contribution for feedback in no way prejudices your chances of getting that contribution accepted, and can save you from putting a lot of work into a contribution that is not suitable for the project.

Code Contributions.¶

Code Review¶

Contributions will not be merged until they’ve been code reviewed. You should implement any code review feedback unless you strongly object to it. In the event that you object to the code review feedback, you should make your case clearly and calmly. If, after doing so, the feedback is judged to still apply, you must either apply the feedback or withdraw your contribution.

Code Style¶

Keep to the existing code style.

Documentation Contributions¶

Documentation improvements are always welcome! The documentation files live in the docs/ directory of the codebase. They’re written in Markdown, and use zensical to generate the full suite of documentation.

Bug Reports¶

Bug reports are important. Before you raise one, though, please check through the GitHub issues, both open and closed, to confirm that the bug hasn’t been reported before. Duplicate bug reports are a drain on the time of other contributors, clog up the issue tracker and should be avoided as much as possible.

Feature Requests¶

bqt happily accept new feature. Forever? Hopefully!