summary refs log tree commit diff
path: root/doc/contributing
Commit message (Collapse)AuthorAge
* CONTRIBUTING.md: Move to repo root, where it is more visible.Niklas Hambüchen2021-06-26
| | | | | | | 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
* doc/manual: Add backport criteriaJonathan Ringer2021-06-09
|
* doc: Use markdown syntax for xrefsJan Tojnar2021-06-07
| | | | | | Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
* doc: prepare for commonmarkJan Tojnar2021-06-07
| | | | | | | | | | | | | | We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
* doc: Document markup syntaxJan Tojnar2021-06-06
| | | | | | | Not depicted: - Diagrams using Lua filter and dot - fenced code attributes (enabled by the attributes extension)
* Merge pull request #125494 from siraben/remove-stdenv-libSandro2021-06-05
|\
| * coding-conventions: remove reference to stdenv.libBen Siraphob2021-06-03
| |
* | doc: Fix make in nix-shellJan Tojnar2021-06-05
|/ | | | When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
* doc/coding-conventions: Add documentation for fetchpatch optional argumentsStefan Frijters2021-05-28
|
* backport action: document the workflowDomen Kožar2021-05-25
|
* doc/submitting-changes: should -> mustAlyssa Ross2021-05-23
| | | | | | | To me, as a native English speaker, this doesn't change the meaning of the sentence at all. But to a non-native speaker, this can read like the staging-next rules are only recommendations. Let's make this clearer.
* Merge pull request #121252 from NixOS/SuperSandro2000-patch-1Sandro2021-05-17
|\ | | | | doc/contributing: add unnecessary string conversions
| * doc/contributing: add unnecessary string conversionsSandro2021-04-30
| |
* | Merge pull request #120534 from davidak/package-testsLuke Granger-Brown2021-05-01
|\ \ | | | | | | doc: add instructions for creating package tests
| * | doc: add instructions for creating package testsdavidak2021-04-24
| | |
* | | doc/contributing: clarify stdenv.lib deprecationSandro2021-04-30
| |/ |/|
* | doc/submitting-changes: remove incorrect remarkPatrick Hilhorst2021-04-26
|/ | | | Tests don't only apply to NixOS modules, see for example tests/vscodium
* doc/contributing/*.xml: Convert to markdownBobby Rong2021-04-23
|
* Merge pull request #116475 from davidak/doc-remove-packagesSamuel Dionne-Riel2021-04-21
|\ | | | | doc: add instructions to remove a package
| * doc: add instructions to remove a packagedavidak2021-04-20
| | | | | | | | | | Co-authored-by: Sandro <sandro.jaeckel@gmail.com> Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
* | docs: correct some englishEvils2021-04-20
| |
* | documentation: Add content about Vulnerability roundupsPamplemousse2021-03-17
|/ | | | Signed-off-by: Pamplemousse <xav.maso@gmail.com>
* doc: FormatRobert Hensing2021-03-04
|
* docs: clarify stagingThomas Bereknyei2021-02-19
| | | | | | Specify that the merges from master to staging-next to staging are performed by GitHub actions. This helps the reader understand the relationship between the branches.
* Merge pull request #109663 from Pamplemousse/documentationRobert Hensing2021-01-26
|\ | | | | documention corrections
| * documentation: correct documentation helpPamplemousse2021-01-19
| | | | | | | | | | | | | | `PANDOC_LUA_FILTERS_DIR` is set in `makeFlags` in `doc/default.nix`, and needs to be explicitely passed to `make` when called manually. Signed-off-by: Pamplemousse <xav.maso@gmail.com>
* | doc: add function argument order convention (#110060)V2021-01-20
|/ | | | | | | | | | | * doc: add function argument order convention Ordering by usage is the de facto ordering given to arguments. It's logical, and makes finding argument usage easier. Putting lib first is common in NixOS modules, so it's reasonable to mirror this in nixpkgs proper. Additionally, it's not a package as such, has zero dependencies, and can be found used anywhere in a derivation. * doc: clean up usage of lib
* doc: add "prefer lib over stdenv.lib" conventionAlyssa Ross2021-01-10
| | | | | | | | I think we should have something in the manual people can point to about this, to avoid rehashing it over and over in PRs. "stdenv.lib" makes it look like lib is part of stdenv, which it isn't, and makes it even more confusing as a newcomer to figure out what stdenv is (and isn't).
* doc: Add staging workflow diagramJan Tojnar2020-12-09
|
* doc: Clean up submitting changesJan Tojnar2020-12-05
|
* doc: convert Submitting changes to MarkdownJan Tojnar2020-12-05
|
* doc: Rename submitting-changes to chapterJan Tojnar2020-12-05
|
* Merge pull request #101806 from unode/docsDomen Kožar2020-12-01
|\ | | | | docs: Add 'how to request merging rights'
| * docs: Add link to the GitHub issue on how to become a committerRenato Alves2020-10-29
| |
* | doc/contributing: remove label instructionsJonathan Ringer2020-11-14
| | | | | | | | ofborg largely does this now
* | doc/*: fix indentationzowoq2020-11-12
| |
* | A directory-category for terminal emulatorsAndersonTorres2020-10-28
|/ | | | | | | | | | | | | This is a mostly cosmetical commit, in the sense it doesn't change the contents of any package, but reorganizes the overall Nixpkgs expressions. Terminal emulators are an ubiquitous tool for any Unix user; even the beginners are routinely familiarized to it. And, manifestly, there are many implementations of terminal emulators out there, from those traditionally made in C and C++ to those written in Haskell and Go. Terminal emulators deserve more highlight. This commit does that by creating a category for them.
* doc: Improve code listingsJan Tojnar2020-09-23
| | | | By adding prompts and removing unnecessary indentation.
* treewide: use https for nixos.org and hydra.nixos.orgPavol Rusnak2020-05-03
| | | | | tarballs.nixos.org is omitted from the change because urls from there are always hashed and checked
* Update commit policy for stable release branches (#86026)davidak2020-04-26
| | | | | only very few people followed the strict policy in the last 5 years. the maintainers accept backports without reason when it's obvious, so i updated the policy to reflect that
* jdiskreport: remove builder.sh link from docsKyle Sferrazza2020-02-10
|
* doc/submitting-changes : improved section 15.1Ingolf Wagner2020-01-03
|
* nixpkgs-review: 2.1.0 -> 2.1.1Jörg Thalheim2019-12-22
| | | | changelog: https://github.com/Mic92/nixpkgs-review/releases/tag/2.1.1
* doc/contributing: mention icons & themes foldersRenaud2019-12-07
| | | (#74376)
* doc/contributing: mention the word “backporting” for grep-abilityProfpatsch2019-11-15
| | | | | When a contributor wants to know how to do this ominous “backporting” everybody is talking about, a grep should be enough to find it.
* nixpkgs manual: add section on submitting security fixesFrederik Rietdijk2019-11-13
|
* nixpkgs manual: fix buildFrederik Rietdijk2019-11-13
| | | | after it was broken by 331f45f7bb5a90ce2b5516a9ae34da566f54e69c
* update contributors documentation for nix-review (#73217)DavHau2019-11-12
| | | | | | | | Useful for newcomers who want to do their review after committing and then stumbling across the PR checklist. * replace nix-shell with nix run
* nixpkgs manual: document staging-next branchFrederik Rietdijk2019-10-31
|
* nixpkgs manual: move contributing chapters into one folderFrederik Rietdijk2019-10-30