os/doc/CONTRIBUTING.md
David Arnold b95189d754
rm: community
the commmunity branch was fallen too far behind and there where no
contributions to it, anyways. We will start linking usage examples
out in the wild, instead.
2021-07-16 12:50:18 -05:00

1.1 KiB

Pull Requests

All development is done in the develop branch. Only minor bug-fixes and release PRs should target master.

If making a change to the template, or adding a feature, please be sure to update the relevant docs. Each directory contains its own README.md, which will automatically be pulled into the mdbook. The book is rendered on every change, so the docs should always be up to date.

We also use BORS to ensure that all pull requests pass the test suite once at least one review is completed.

Style

If you wish to contribute please follow these guidelines:

  • format your code with nixpkgs-fmt. The default devshell includes a pre-commit hook that does this for you.

  • The commit message follows the same semantics as nixpkgs.

    • You can use a # symbol to specify ambiguities. For example, develop#zsh: <rest of commit message> would tell me that you're updating the zsh subprofile living under the develop profile.