summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)Author
2024-05-13Remove mentions of documentation-reviewers teamSilvan Mosberger
See also https://github.com/NixOS/nix.dev/pull/978
2024-04-20contributing: add link to rebasing+squashingMarcelo Giles
contributing: update link to rebasing+squashing
2024-03-28treewide: Switch markdown placeholder from "..." to <...>Janne Heß
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-28treewide: Fix all Nix ASTs in all markdown filesJanne Heß
This allows for correct highlighting and maybe future automatic formatting. The AST was verified to work with nixfmt only.
2024-02-23CONTRIBUTING.md: change table column order for stagingbenaryorg
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-12CONTRIBUTING.md: Sandboxing is enabled by default on Linuxibbem
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-01-19doc: fix typoPhilipp Riegger
2024-01-15doc: mention new documentation-reviewers subteamValentin Gagarin
2023-12-06CONTRIBUTING.md: Dedent warnings until GitHub fixes itSilvan Mosberger
https://github.com/orgs/community/discussions/16925#discussioncomment-7574895
2023-12-06CONTRIBUTING.md: Update markdown emphasising syntaxSilvan Mosberger
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-11-27{CONTRIBUTING,PULL_REQUEST_TEMPLATE}.md: update NixOS releasefigsoda
2023-11-14Merge pull request #263059 from DanielSidhion/add-doc-conventionSilvan Mosberger
doc: commit header convention for documentation changes
2023-11-13doc: separate commit header conventions for each area, info on docs changes.DS
2023-11-13Merge pull request #263575 from pbsds/contributing-link-naming-conventinoSilvan Mosberger
CONTRIBUTING: Add hotlinks to package and module reviewing guides, minor touchups
2023-11-13{pkgs,nixos}/README.md: Hotlink package and module reviewing guidelines, fix ↵Peder Bergebakken Sundt
references
2023-11-11treewide: fix redirected and broken URLsAnthony Roussel
Using the script in maintainers/scripts/update-redirected-urls.sh
2023-11-09Update CONTRIBUTING.mdShahar "Dawn" Or
2023-10-21CONTRIBUTING.md: fix a missing sentence endingh7x4
2023-10-16CONTRIBUTING.md: fix a typo of link to maintainersKenichi Kamiya
2023-09-06CONTRIBUTING.md: Reword changes acceptable for backportSilvan Mosberger
It wasn't entirely clear if the list was acceptable or not from the wording.
2023-09-04CONTRIBUTING: Add note about how to commit new maintainers-list.nix entryMatthias Beyer
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2023-08-28docs: fix link to Nix manual on sandbox configHraban Luyat
2023-08-20CONTRIBUTING: remove suggestion about the order of argumentsAnderson Torres
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-14CONTRIBUTING.md: Move boot loader-specific sentence to pkgs/README.mdSilvan Mosberger
This needs a rewrite at some point..
2023-08-14CONTRIBUTING.md: Typos and formattingSilvan Mosberger
- 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-14CONTRIBUTING.md: Minor content updates based on reviewsSilvan Mosberger
- 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-14CONTRIBUTING.md: Move sections aroundSilvan Mosberger
Yeah I'm totally getting lazy with the commits, but it's really hard and takes a long time..
2023-08-14CONTRIBUTING.md: Minor fixesSilvan Mosberger
2023-08-14CONTRIBUTING.md: New section on which branch to useSilvan Mosberger
2023-08-13CONTRIBUTING.md: Move rebasing section upSilvan Mosberger
Right into the "How to propose a change" section, because that's where it's relevant
2023-08-13CONTRIBUTING.md: Remove duplicated sectionSilvan Mosberger
How to force push to PR's is already explained in the "How to propose a change" section at the beginning
2023-08-13CONTRIBUTING.md: Minor formatting fixesSilvan Mosberger
2023-08-13CONTRIBUTING.md: Clean up releases sectionSilvan Mosberger
2023-08-13CONTRIBUTING.md: Move release sections togetherSilvan Mosberger
Will be cleaned up in the next commit
2023-08-13CONTRIBUTING.md: Clean up and condense staging workflow sectionSilvan Mosberger
2023-08-13CONTRIBUTING.md: Replace staging workflow diagramSilvan Mosberger
Can't be rendered in GitHub markdown, replacing it with a Git branch diagram using mermaid
2023-08-13CONTRIBUTING.md: Move flow of changes section upSilvan Mosberger
2023-08-13CONTRIBUTING.md: Clean up "Making patches" sectionSilvan Mosberger
Moving and collecting bits into the appropriate places, also writing some new sentences
2023-08-13CONTRIBUTING.md: Write a new section on how to propose a changeSilvan Mosberger
Removing paragraphs from the other sections that aren't necessary anymore
2023-08-13CONTRIBUTING.md: Coding conventions -> code conventionsSilvan Mosberger
It's not conventions about how to do coding, it's about what the code should look like
2023-08-13CONTRIBUTING.md: Collect paragraphs into a new commit conventions sectionSilvan Mosberger
2023-08-13CONTRIBUTING.md: Move pull request template section to the bottomSilvan Mosberger
2023-08-13CONTRIBUTING.md: Add overviewSilvan Mosberger
2023-08-13CONTRIBUTING.md: Add introSilvan Mosberger
2023-08-13Move CONTRIBUTING-new.md to CONTRIBUTING.mdSilvan Mosberger
The -new version was assembled in the previous commits
2023-08-13CONTRIBUTING.md: Remove temporarilySilvan Mosberger
So that the CONTRIBUTING-new.md can take its place and Git detect the rename
2023-08-13CONTRIBUTING.md: Move opening issues section to Nixpkgs manualSilvan Mosberger
This isn't relevant to contributors specifically, it applies to all users
2023-08-13CONTRIBUTING.md: Rough move to new contribution doc filesSilvan Mosberger
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-12CONTRIBUTING.md: highlight the need for setting `meta.mainProgram`Anderson Torres
2023-06-20contributing: Explain how to run common testsVictor Engmark
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>