pub-solar-os/doc/CONTRIBUTING.md

26 lines
1.1 KiB
Markdown
Raw Normal View History

2021-02-15 00:41:15 +00:00
# Pull Requests
2021-06-03 19:25:06 +00:00
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
2021-02-15 00:41:15 +00:00
relevant docs. Each directory contains its own README.md, which will
2021-02-18 04:03:07 +00:00
automatically be pulled into the [mdbook](https://devos.divnix.com). The book is
2021-02-15 00:41:15 +00:00
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.
2021-02-15 00:41:15 +00:00
# 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
2021-02-15 00:41:15 +00:00
`zsh` subprofile living under the `develop` profile.
[nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt
[nixpkgs]: https://github.com/NixOS/nixpkgs