Commit Graph

90 Commits

Author SHA1 Message Date
Anderson Torres
857f57ffd8 CONTRIBUTING.md: highlight the need for setting meta.mainProgram 2023-08-12 23:00:15 +00:00
Victor Engmark
96299edd4c contributing: Explain how to run common tests
As a beginning contributor, it is far from obvious where to find tests,
how to run individual tests locally for quick development, and which
tests do what. The new "Testing changes" section aims to help with all
of these.

Co-authored-by: Emily <git@emilylange.de>
2023-06-20 08:29:47 +12:00
Pol Dellaiera
32b1e4642b
Merge pull request #238126 from nikstur/contributing-release-notes
CONTRIBUTING.md: remove historical trivia
2023-06-17 17:16:54 +02:00
nikstur
2c7d7e428c CONTRIBUTING.md: remove historical trivia
The transition to markdown is done now and the historical trivia is not
helpful for first time contributers who are the primary audience for
this document. Telling the user to edit a file by editing a file is
superfluous.
2023-06-16 23:50:47 +02:00
piegames
6b1052e4e3 CONTRIBUTING.md: Add section for mass-ping handling 2023-06-12 00:56:35 +02:00
Raito Bezarius
2c6ae7132c
Release NixOS 23.05 2023-05-31 22:52:52 +02:00
Jean-Paul Calderone
51e0e48f35 CONTRIBUTING.md: Clarify guidelines for meta.description 2023-04-24 12:44:11 +00:00
pennae
d041641b1a nixos/manual: remove md-to-db
with manual chapters no longer needing pandoc for their conversion to
xml we can get rid of this source of confusion, and its huge cache of
xml files.
2023-02-10 06:40:15 +01:00
AndersonTorres
5b86dce808 CONTRIBUTING.md: clarify some directives about meta attributes 2022-12-31 12:12:50 -03:00
Sandro Jäckel
10600db299
CONTRIBUTING: add links to online resources 2022-12-24 02:13:04 +01:00
figsoda
ec8cb34358 treewide: fix typos 2022-12-17 19:39:44 -05:00
Sandro
756a5e6b74
CONTRIBUTING: loose squash merging rules (#204988)
Co-authored-by: Naïm Favier <n@monade.li>
2022-12-14 23:36:21 +01:00
Naïm Favier
acd55240da
Merge pull request #196153 from ncfavier/contributing-no-squash 2022-12-02 13:47:26 +01:00
Martin Weinelt
f1b9cc23aa Release NixOS 22.11 2022-11-30 11:52:38 +01:00
Martin Weinelt
8e4f5036ee
CONTRIBUTING: Reference release notes in package bumps
This change improves the recommendation for good commit messages to
include release notes on package bumps.

Including the release notes increases the likelihood that they will be
taken into consideration during review. Having them included in the
review is important to be able to judge whether changes made during a
version bump are sensible, sufficient or complete.

The burden of retrieving the release notes for arbitrary package bumps
should not rest on the relatively small group of reviewers.

Signed-off-by: Martin Weinelt <hexa@darmstadt.ccc.de>
2022-11-14 17:27:18 +01:00
Naïm Favier
714f943984
CONTRIBUTING.md: "no squash merges" 2022-10-15 18:02:43 +02:00
piegames
f4e2a3c698
Merge #175352: CONTRIBUTING.md: simplify rebasing instructions 2022-08-15 12:53:30 +02:00
Markus S. Wamser
924b27e479 CONTRIBUTING.md: use 22.05 as target branch for backports 2022-05-31 10:07:21 +02:00
Janne Heß
cbaacfb8df
Release 22.05 2022-05-30 20:50:07 +02:00
Naïm Favier
d2990717f1
CONTRIBUTING.md: simplify rebasing instructions
Makes the instructions easier to remember (and type) using the
`git rebase --onto A...B` syntax to find the merge base between A and B
(which has been in git for at least 10 years).

We also assume that the merge base between staging and master is also
the merge base between staging and the current branch (since it is based
on master), and giving master as the <upstream> branch makes git
consider the commits in the current branch that are not in master, so
there's no need to compute the merge base between master and the current
branch.

In the same spirit of discouraging copy-and-paste, use a placeholder
name for the current branch instead of `$(git branch --show-current)`.
2022-05-29 22:10:47 +02:00
Arnout Engelen
d73290c6dd
CONTRIBUTING.md: document using labels for backporting 2022-05-28 13:58:31 +02:00
Martin Weinelt
cd00cafaad
CONTRIBUTING.md: encourage linking release notes on updates
Makes it easier for reviewers to look through the changes and is a sane
default to reference if one exists.
2022-04-05 12:50:46 +02:00
Martin Weinelt
0f4a2f12af fixup! CONTRIBUTING: rebase master to staging without pinging people 2022-04-03 21:07:41 +02:00
Jörg Thalheim
af8c598679
CONTRIBUTING: rebase master to staging without pinging people
Co-Authored-By: Martin Weinelt <hexa@darmstadt.ccc.de>
Co-Authored-By: Janne Heß <janne@hess.ooo>
2022-03-30 22:57:00 +02:00
Niklas Hambüchen
11d91bd318
CONTRIBUTING: Make clearer where branch policy can be found 2022-01-04 21:43:10 +01:00
Bobby Rong
af21d41260
.github/PULL_REQUEST_TEMPLATE.md, CONTRIBUTING.md: 21.11 -> 22.05 (#147977)
* .github/PULL_REQUEST_TEMPLATE.md: 21.11 -> 22.05

* CONTRIBUTING.md: 21.11 -> 22.05
2021-11-30 00:20:21 -05:00
Smittyvb
d3841d1e7b
CONTRIBUTING.md: fix link to COPYING
The current link 404s when viewed on GitHub due to using a relative
path that refers to an upper directory.
2021-08-10 08:38:41 -04:00
Niklas Hambüchen
3c29ced243 CONTRIBUTING.md: Move to repo root, where it is more visible.
We found that many users found it difficult to locate this document.

Github supports it in the root, see:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
2021-06-26 04:51:38 +02:00
Eelco Dolstra
88f5d1c8ba Move CONTRIBUTING.md to .github
See https://github.com/blog/2111-issue-and-pull-request-templates.
2016-02-19 10:59:38 +01:00
Vladimír Čunát
0ad7b1f44a CONTRIBUTING.md: add a notice about licensing
This suplements changes from #11557; see the long discussion.
2015-12-19 14:38:00 +01:00
Luca Bruno
cb46ba4b16 CONTRIBUTING: link to latest hydra build of nixpkgs manual 2015-07-14 10:32:26 +02:00
Cillian de Róiste
3a0707f0c7 Move the details from CONTRIBUTING.md to the manual #8734 2015-07-12 13:33:55 +02:00
devhell
f495ae3085 CONTRIBUTING.md: Some minor clean-ups 2015-07-10 21:54:51 +01:00
Luca Bruno
b4e5181dde CONTRIBUTING: add some notes about commit policy 2015-07-10 11:56:04 +02:00
Arseniy Seroka
0ba0ae752c CONTRIBUTING.md: fix typos 2015-06-21 18:32:54 +03:00
Domen Kožar
eb6be740ec CONTRIBUTING.md: fix style 2015-06-21 14:39:46 +02:00
Domen Kožar
75f4709fe3 CONTRIBUTING.md: mostly style fixes 2015-06-21 14:38:20 +02:00
Arseniy Seroka
ef22e1157b CONTRIBUTING.md: fix examples 2015-06-21 15:29:30 +03:00
Andrew Kelley
c78005aac2 fix typos in CONTRIBUTING.md 2015-06-17 13:58:36 -07:00
Arseniy Seroka
6686914d71 CONTRIBUTING.md: initial 2015-05-25 00:12:40 +03:00