3c009e35d3
contributing: add link to rebasing+squashing
...
contributing: update link to rebasing+squashing
2024-04-20 20:15:51 -07:00
bc5ee2b8f8
treewide: Switch markdown placeholder from "..." to <...>
...
We use angle brackets since they look a lot like a placeholder while
also being valid nix code, as suggested by roberth here: https://github.com/NixOS/nixpkgs/pull/299554#discussion_r1541797970
2024-03-28 09:28:12 +01:00
fcc95ff817
treewide: Fix all Nix ASTs in all markdown files
...
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
c3b66ce3cc
CONTRIBUTING.md: change table column order for staging
...
The graph right above the table has the order as `master` ⇒ `staging-next` ⇒ `staging`.
This corresponds with the workflow, i.e. automatic merges happen in that direction and the manual merging is in reverse direction of that.
As a first time reader of this document the table was very confusing due to the disparity of that.
With this change the table should read more fluently for people not familiar with the workflow since the table follows the step-by-step flow of commits.
Signed-off-by: benaryorg <binary@benary.org>
2024-02-23 17:28:16 +00:00
6ef8838dcf
CONTRIBUTING.md: Sandboxing is enabled by default on Linux
...
The fact that sandboxing is already enabled by default is mentioned in
the pull request template. Hence, it might be confusing to ask to enable
sandboxing in CONTRIBUTING.md.
Also follow the `one sentence per line` guideline.
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-02-12 11:08:47 +01:00
da74a75303
doc: fix typo
2024-01-19 12:00:16 +01:00
f1601b35e7
doc: mention new documentation-reviewers subteam
2024-01-15 21:01:21 +01:00
e88fb997e3
CONTRIBUTING.md: Dedent warnings until GitHub fixes it
...
https://github.com/orgs/community/discussions/16925#discussioncomment-7574895
2023-12-06 04:04:01 +01:00
4769458228
CONTRIBUTING.md: Update markdown emphasising syntax
...
GitHub supported special markdown syntax for emphasising blocks for some
time. This was however a beta feature, and still is, so it's subject to
changes.
Recently such a change happened: The syntax is different now.
See https://github.com/orgs/community/discussions/16925 for more
information
2023-12-06 03:51:39 +01:00
43a3d2d90e
{CONTRIBUTING,PULL_REQUEST_TEMPLATE}.md: update NixOS release
2023-11-27 17:33:01 -05:00
e89ad83555
Merge pull request #263059 from DanielSidhion/add-doc-convention
...
doc: commit header convention for documentation changes
2023-11-14 08:11:41 +01:00
e93a3d7b58
doc: separate commit header conventions for each area, info on docs changes.
2023-11-13 20:41:08 -08:00
fdee770336
Merge pull request #263575 from pbsds/contributing-link-naming-conventino
...
CONTRIBUTING: Add hotlinks to package and module reviewing guides, minor touchups
2023-11-13 14:01:33 +01:00
8feb68f965
{pkgs,nixos}/README.md: Hotlink package and module reviewing guidelines, fix references
2023-11-13 13:46:14 +01:00
e30f48be94
treewide: fix redirected and broken URLs
...
Using the script in maintainers/scripts/update-redirected-urls.sh
2023-11-11 10:49:01 +01:00
54b6d7de0f
Update CONTRIBUTING.md
2023-11-09 14:53:23 +07:00
216b2bdf7f
CONTRIBUTING.md: fix a missing sentence ending
2023-10-21 02:04:09 +02:00
9961e93d6b
CONTRIBUTING.md: fix a typo of link to maintainers
2023-10-16 19:15:13 +09:00
433f935d10
CONTRIBUTING.md: Reword changes acceptable for backport
...
It wasn't entirely clear if the list was acceptable or not from the
wording.
2023-09-06 20:12:50 +02:00
aa25691630
CONTRIBUTING: Add note about how to commit new maintainers-list.nix entry
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2023-09-04 10:29:20 +02:00
3a8f2d0e9f
docs: fix link to Nix manual on sandbox config
2023-08-28 14:12:27 -04:00
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
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
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
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
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
16651342ea
CONTRIBUTING.md: Minor fixes
2023-08-14 02:51:00 +02:00
0bd8c9b4f9
CONTRIBUTING.md: New section on which branch to use
2023-08-14 02:20:56 +02:00
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
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
4e3064d1b9
CONTRIBUTING.md: Minor formatting fixes
2023-08-13 22:29:52 +02:00
3639a9e482
CONTRIBUTING.md: Clean up releases section
2023-08-13 22:04:58 +02:00
b665608845
CONTRIBUTING.md: Move release sections together
...
Will be cleaned up in the next commit
2023-08-13 22:04:58 +02:00
9cae39708b
CONTRIBUTING.md: Clean up and condense staging workflow section
2023-08-13 22:04:57 +02:00
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
aace54f1aa
CONTRIBUTING.md: Move flow of changes section up
2023-08-13 22:04:57 +02:00
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
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
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
dfe311b1b8
CONTRIBUTING.md: Collect paragraphs into a new commit conventions section
2023-08-13 22:04:57 +02:00
9489e19e21
CONTRIBUTING.md: Move pull request template section to the bottom
2023-08-13 22:04:57 +02:00
ecee8c3af4
CONTRIBUTING.md: Add overview
2023-08-13 22:04:57 +02:00
3d5fc07cfb
CONTRIBUTING.md: Add intro
2023-08-13 22:04:57 +02:00
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
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
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
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
857f57ffd8
CONTRIBUTING.md: highlight the need for setting `meta.mainProgram`
2023-08-12 23:00:15 +00:00
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
32b1e4642b
Merge pull request #238126 from nikstur/contributing-release-notes
...
CONTRIBUTING.md: remove historical trivia
2023-06-17 17:16:54 +02:00
Marcelo Giles