home-manager/.github/PULL_REQUEST_TEMPLATE.md

### Description

<!--

Please provide a brief description of your change.

-->

### Checklist

<!--

Please go through the following checklist before opening a non-WIP
pull-request.

Also make sure to read the guidelines found at

  https://nix-community.github.io/home-manager/#sec-guidelines

-->

- [ ] Change is backwards compatible.

- [ ] Code formatted with `./format`.

- [ ] Code tested through `nix-shell --pure tests -A run.all` or `nix develop --ignore-environment .#all` using Flakes.

- [ ] Test cases updated/added. See [example](https://github.com/nix-community/home-manager/commit/f3fbb50b68df20da47f9b0def5607857fcc0d021#diff-b61a6d542f9036550ba9c401c80f00ef).

- [ ] Commit messages are formatted like

    ```
    {component}: {description}

    {long description}
    ```

    See [CONTRIBUTING](https://nix-community.github.io/home-manager/#sec-commit-style) for more information and [recent commit messages](https://github.com/nix-community/home-manager/commits/master) for examples.

- If this PR adds a new module

  - [ ] Added myself as module maintainer. See [example](https://github.com/nix-community/home-manager/blob/068ff76a10e95820f886ac46957edcff4e44621d/modules/programs/lesspipe.nix#L6).

#### Maintainer CC

<!--
If you are updating a module, please @ people who are in its `meta.maintainers` list.
If in doubt, check `git blame` for whoever last touched something.
-->
doc: add contribution guidelines section This adds a section in the documentation for describing a list of guidelines that code in Home Manager should follow. This also updates the pull request template to reference this new section. 2020-05-23 14:07:19 +02:00			`### Description`

Add code owners and pull request template 2020-04-08 19:22:36 +02:00			`<!--`

doc: add contribution guidelines section This adds a section in the documentation for describing a list of guidelines that code in Home Manager should follow. This also updates the pull request template to reference this new section. 2020-05-23 14:07:19 +02:00			`Please provide a brief description of your change.`
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
			`-->`

doc: add contribution guidelines section This adds a section in the documentation for describing a list of guidelines that code in Home Manager should follow. This also updates the pull request template to reference this new section. 2020-05-23 14:07:19 +02:00			`### Checklist`

			`<!--`
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
doc: add contribution guidelines section This adds a section in the documentation for describing a list of guidelines that code in Home Manager should follow. This also updates the pull request template to reference this new section. 2020-05-23 14:07:19 +02:00			`Please go through the following checklist before opening a non-WIP`
			`pull-request.`
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
doc: add contribution guidelines section This adds a section in the documentation for describing a list of guidelines that code in Home Manager should follow. This also updates the pull request template to reference this new section. 2020-05-23 14:07:19 +02:00			`Also make sure to read the guidelines found at`
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
github: fix broken links Current links to contributing and commit style guidelines are out of date. 2024-01-04 16:58:32 +01:00			`https://nix-community.github.io/home-manager/#sec-guidelines`
doc: add contribution guidelines section This adds a section in the documentation for describing a list of guidelines that code in Home Manager should follow. This also updates the pull request template to reference this new section. 2020-05-23 14:07:19 +02:00
			`-->`

			`- [ ] Change is backwards compatible.`
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
			- [ ] Code formatted with `./format`.

PR_TEMPLATE: Note nix3 test method in checklist (#3972) * PR_TEMPLATE: Note nix3 test method in checklist Allows for running with the `nixpkgs` from the lock file, as well as using a more familiar interface for users of the experimental CLI, which would've avoided me opening #3971. Also updates the corresponding note in `docs/contributing.adoc` to have the correct invocation path. * PR_TEMPLATE: `the experimental CLI` -> `Flakes` 2023-05-17 12:59:35 +02:00			- [ ] Code tested through `nix-shell --pure tests -A run.all` or `nix develop --ignore-environment .#all` using Flakes.
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
tree-wide: update url to the repo 2020-10-19 21:20:37 +02:00			`- [ ] Test cases updated/added. See [example](https://github.com/nix-community/home-manager/commit/f3fbb50b68df20da47f9b0def5607857fcc0d021#diff-b61a6d542f9036550ba9c401c80f00ef).`
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
			`- [ ] Commit messages are formatted like`

			```
			`{component}: {description}`

			`{long description}`
			```

github: fix broken links Current links to contributing and commit style guidelines are out of date. 2024-01-04 16:58:32 +01:00			`See [CONTRIBUTING](https://nix-community.github.io/home-manager/#sec-commit-style) for more information and [recent commit messages](https://github.com/nix-community/home-manager/commits/master) for examples.`
Add code owners and pull request template 2020-04-08 19:22:36 +02:00
			`- If this PR adds a new module`

tree-wide: update url to the repo 2020-10-19 21:20:37 +02:00			`- [ ] Added myself as module maintainer. See [example](https://github.com/nix-community/home-manager/blob/068ff76a10e95820f886ac46957edcff4e44621d/modules/programs/lesspipe.nix#L6).`
PULL_REQUEST_TEMPLATE.md: add maintainer cc section (#4193) 2023-07-04 12:41:04 +02:00
			`#### Maintainer CC`

			`<!--`
			If you are updating a module, please @ people who are in its `meta.maintainers` list.
			If in doubt, check `git blame` for whoever last touched something.
			`-->`