Commit Graph

67 Commits

Author SHA1 Message Date
Hraban Luyat
3a8f2d0e9f docs: fix link to Nix manual on sandbox config 2023-08-28 14:12:27 -04:00
Anderson Torres
c483f199f7 CONTRIBUTING: remove suggestion about the order of arguments
Particularities about style should be enforced at the tooling level (linters,
code beautifiers etc.). Otherwise, it adds more weight on the PR reviewing,
distracting both authors and reviewers from the substance of the changes.
2023-08-20 11:10:34 -03:00
Silvan Mosberger
de5a39f5e7 CONTRIBUTING.md: Move boot loader-specific sentence to pkgs/README.md
This needs a rewrite at some point..
2023-08-14 19:50:02 +02:00
Silvan Mosberger
2ce1e0b2cc CONTRIBUTING.md: Typos and formatting
- Fix sentence about meeting contributing standards
- pkgs -> packages
- Use emoji's because GitHub renders the :*: things weird sometimes
- Move a dot

Co-authored-by: Rémi NICOLE <minijackson@users.noreply.github.com>
2023-08-14 19:49:29 +02:00
Silvan Mosberger
237799aa8e CONTRIBUTING.md: Minor content updates based on reviews
- Contributing without a GitHub account
- Mention OfBorg
- nix.useSandbox -> nix.settings.sandbox
- nixpkgs-review is good for not just version updates

Co-authored-by: Rémi NICOLE <minijackson@users.noreply.github.com>
2023-08-14 19:49:02 +02:00
Silvan Mosberger
b069d2dfec CONTRIBUTING.md: Move sections around
Yeah I'm totally getting lazy with the commits, but it's really hard and
takes a long time..
2023-08-14 03:48:41 +02:00
Silvan Mosberger
16651342ea CONTRIBUTING.md: Minor fixes 2023-08-14 02:51:00 +02:00
Silvan Mosberger
0bd8c9b4f9 CONTRIBUTING.md: New section on which branch to use 2023-08-14 02:20:56 +02:00
Silvan Mosberger
2a99b5a703 CONTRIBUTING.md: Move rebasing section up
Right into the "How to propose a change" section, because that's where
it's relevant
2023-08-13 22:34:34 +02:00
Silvan Mosberger
2f345d070b CONTRIBUTING.md: Remove duplicated section
How to force push to PR's is already explained in the
"How to propose a change" section at the beginning
2023-08-13 22:32:45 +02:00
Silvan Mosberger
4e3064d1b9 CONTRIBUTING.md: Minor formatting fixes 2023-08-13 22:29:52 +02:00
Silvan Mosberger
3639a9e482 CONTRIBUTING.md: Clean up releases section 2023-08-13 22:04:58 +02:00
Silvan Mosberger
b665608845 CONTRIBUTING.md: Move release sections together
Will be cleaned up in the next commit
2023-08-13 22:04:58 +02:00
Silvan Mosberger
9cae39708b CONTRIBUTING.md: Clean up and condense staging workflow section 2023-08-13 22:04:57 +02:00
Silvan Mosberger
7ab012c60c CONTRIBUTING.md: Replace staging workflow diagram
Can't be rendered in GitHub markdown, replacing it with a Git branch diagram using mermaid
2023-08-13 22:04:57 +02:00
Silvan Mosberger
aace54f1aa CONTRIBUTING.md: Move flow of changes section up 2023-08-13 22:04:57 +02:00
Silvan Mosberger
5789cc3754 CONTRIBUTING.md: Clean up "Making patches" section
Moving and collecting bits into the appropriate places, also writing
some new sentences
2023-08-13 22:04:57 +02:00
Silvan Mosberger
67ae88c072 CONTRIBUTING.md: Write a new section on how to propose a change
Removing paragraphs from the other sections that aren't necessary anymore
2023-08-13 22:04:57 +02:00
Silvan Mosberger
99c6942d83 CONTRIBUTING.md: Coding conventions -> code conventions
It's not conventions about how to do coding, it's about what the code
should look like
2023-08-13 22:04:57 +02:00
Silvan Mosberger
dfe311b1b8 CONTRIBUTING.md: Collect paragraphs into a new commit conventions section 2023-08-13 22:04:57 +02:00
Silvan Mosberger
9489e19e21 CONTRIBUTING.md: Move pull request template section to the bottom 2023-08-13 22:04:57 +02:00
Silvan Mosberger
ecee8c3af4 CONTRIBUTING.md: Add overview 2023-08-13 22:04:57 +02:00
Silvan Mosberger
3d5fc07cfb CONTRIBUTING.md: Add intro 2023-08-13 22:04:57 +02:00
Silvan Mosberger
350eb69c17 Move CONTRIBUTING-new.md to CONTRIBUTING.md
The -new version was assembled in the previous commits
2023-08-13 22:04:57 +02:00
Silvan Mosberger
1a2906024a CONTRIBUTING.md: Remove temporarily
So that the CONTRIBUTING-new.md can take its place and Git detect the
rename
2023-08-13 22:04:57 +02:00
Silvan Mosberger
37968083e7 CONTRIBUTING.md: Move opening issues section to Nixpkgs manual
This isn't relevant to contributors specifically, it applies to all
users
2023-08-13 22:04:57 +02:00
Silvan Mosberger
b7c525806e CONTRIBUTING.md: Rough move to new contribution doc files
No content was changed, new titles are wrapped with () to signal that
they will need to be decided on in a future commit.
2023-08-13 22:01:23 +02:00
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