Contributing guide¶

See https://dmyersturnbull.github.io/ref/contributor-guide/
but disregard the `security:` commit type, which we don’t use.

Feel free to ask a question on the Discussions tab. New issues and pull requests are also welcome. Contributors are asked to abide by the GitHub community guidelines and the Contributor Code of Conduct, version 2.0.

Starting work¶

Install the GitHub CLI if you haven’t already. You may want to discuss with the maintainers before starting any work to avoid wasting any time. Please create an issue for this.

To fork and clone, run

gh repo fork https://github.com/<org>/<repo> --default-branch-only --clone

Coding & committing¶

It is best to configure Git to use your GPG keys. See the Git, SSH, and GPG guide.

For open source projects, commit using --signoff, which indicates certifies under the Developer Certificate of Origin that you have the right to submit your contributions under this project’s license.

Python¶

Always run hatch run fmt before committing to auto-format your code.

To commit, use hatch run commit --signoff. You can also use git commit directly by following supplemental commit messages.

--signoff indicates certifies under the Developer Certificate of Origin that you have the right to submit your contributions under this project’s license.

Other languages¶

Format your code before committing. Commit with git commit --signoff.

Submitting a pull request¶

gh pr create --fill --web --draft

Consider using rebase -i to clean up your commits. Edit (e) commit messages to clarify them and fixup (f) any messages that should be excluded.

To open a pull request, run

gh pr create --fill --title '<type>: <message>' --web

(Refer to the table below for the types.) When you’re ready, mark your pull request as “ready for review” on github.com or by running

gh pr ready <id>

Conventions¶

Maintainers can fix up your commits. You can also refer to the coding conventions.

Commit and issue types¶

For more details, see the GitHub labels document.