Code of Conduct¶
This project and repository is governed by Mozilla’s code of conduct and etiquette guidelines. For more details please see the CODE_OF_CONDUCT.md file.
All bugs are tracked in Bugzilla.
Write up a new bug:
If you want to do work for which there is no bug, it’s best to write up a bug first. Maybe the ensuing conversation can save you the time and trouble of making changes!
Pull request summary should indicate the bug the pull request addresses. For example:
bug NNNNNNN: removed frob from tree class
Pull request descriptions should cover at least some of the following:
what is the problem the pull request is addressing?
why does this pull request fix the issue?
what did you do to test the changes?
any steps-to-reproduce for the reviewer to use to test the changes
any special instructions or things you want the reviewer to check out
Pull requests should be reviewed before merging.
Style nits should be covered by linting as much as possible.
Code reviews should review the changes in the context of the rest of the system.
Preparing to contribute changes to Tecken¶
If you’re interested in helping out and taking a bug to work on, you need to do the following first:
We can’t assign bugs to you until you’ve done at least those two steps.
Python code conventions¶
All Python code files should have an MPL v2 header at the top:
# This Source Code Form is subject to the terms of the Mozilla Public # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/.
To lint all the code, do:
$ make lint
To reformat all the code, do:
$ make lintfix
/* * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
First line is a summary of the commit. It should start with:
bug nnnnnnn: summary
After that, the commit should explain why the changes are being made and any notes that future readers should know for context or be aware of.
Documentation for Tecken is build with Sphinx and is available on ReadTheDocs.
To build the docs, do:
$ make docs
docs/_build/html/index.html in your browser.
See the testing documentation at https://tecken.readthedocs.io/en/latest/dev.html .