devos/doc/CONTRIBUTING.md

# Pull Requests
If making a change to core, 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.

## Community PRs
While much of your work in this template may be idiosyncratic in nature. Anything
that might be generally useful to the broader NixOS community can be synced to
the `community` branch to provide a host of useful NixOS configurations available
"out of the box".

# 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 your updating the
  `zsh` subprofile living under the `develop` profile.

[nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt
[nixpkgs]: https://github.com/NixOS/nixpkgs
doc: finish `flk` reference 2021-02-15 01:41:15 +01:00			`# Pull Requests`
			`If making a change to core, or adding a feature, please be sure to update the`
			`relevant docs. Each directory contains its own README.md, which will`
README.md: fix guide link 2021-02-18 05:03:07 +01:00			`automatically be pulled into the [mdbook](https://devos.divnix.com). The book is`
doc: finish `flk` reference 2021-02-15 01:41:15 +01:00			`rendered on every change, so the docs should always be up to date.`

treewide cleanups and refactoring for initial tests (#157) - [x] refactor lib into separate files, similar to NixOS/nixpkgs/lib. - [x] refactor ci to automatically generate derivations from flake outputs - [x] remove cluttered indirection statements throughout the codebase - [x] refactor hosts to allow for upcoming integration tests - [x] improve ambiguity in the existing docs - [x] add [BORS](https://bors.tech) support - [x] add initial integration test - [x] write tests documentation - [x] test lib - [x] improve version string generation, and do so automatically for pkgs/flake.nix sources Clean up the codebase as best we can in preparation for #152 and add tests. From now on, all PRs will be merged with BORS. 2021-03-14 08:10:51 +01:00			`We also use [BORS](https://bors.tech) to ensure that all pull requests pass the`
			`test suite once at least one review is completed.`
doc: finish `flk` reference 2021-02-15 01:41:15 +01:00
			`## Community PRs`
			`While much of your work in this template may be idiosyncratic in nature. Anything`
			`that might be generally useful to the broader NixOS community can be synced to`
			the `community` branch to provide a host of useful NixOS configurations available
			`"out of the box".`

			`# 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 your updating the
			`zsh` subprofile living under the `develop` profile.

			`[nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt`
			`[nixpkgs]: https://github.com/NixOS/nixpkgs`