73431f5709
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.
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
# 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](https://devos.divnix.com). The book is
|
|
rendered on every change, so the docs should always be up to date.
|
|
|
|
We also use [BORS](https://bors.tech) 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`][nixpkgs-fmt]. The default devshell
|
|
includes a pre-commit hook that does this for you.
|
|
|
|
* The commit message follows the same semantics as [nixpkgs][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.
|
|
|
|
[nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt
|
|
[nixpkgs]: https://github.com/NixOS/nixpkgs
|