Commit graph

89 commits

Author SHA1 Message Date
Wolfgang Walther 32a1561a8b
pkgs/README: clarify active committer role for browsers
A small carification of what "active committer" actually means for
security-critical, fast-moving packages.
2025-10-19 11:55:38 +02:00
Gavin John 0f8e03415b
pkgs/README: Add meta.sourceProvenance requirement 2025-10-03 11:26:30 -07:00
Silvan Mosberger cbe4747210
pkgs/README: Clarify library dependent incluson criterion (#425473) 2025-09-22 15:07:11 +00:00
TomRomeo ca66a204a1
doc: update wrongly formatted alert in nixpkgs README.md 2025-09-08 19:44:56 +02:00
Sandro a08dbcc233
pkgs/README: update buildMozillaMach location (#434961) 2025-09-08 14:50:29 +02:00
Philip Taron 52b3840b82
pkgs/README.md: discourage overrideAttrs within Nixpkgs (#421201) 2025-09-07 17:27:38 +02:00
Alyssa Ross 0ca42f8968
pkgs/README.md: discourage overrideAttrs within Nixpkgs
This comes up quite a lot in review, and we've just had a close call
with a known vulnerable library version almost being reintroduced
without appropriate knownVulnerabilities markings in an override in
the expression for a leaf package.  Let's take the first step towards
preventing that sort of thing happening again.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2025-09-06 11:40:06 +02:00
Ben Siraphob 2f77d9aa7c
pkgs: fix README typos 2025-08-27 11:46:28 -07:00
06kellyjac 6c1d4d9fc0 pkgs/README: update buildMozillaMach location 2025-08-19 12:20:22 +01:00
Doron Behar 6857dc8712 pkgs/README: Document commit prefixes & automatic CI builds
Somewhat based upon ofborg's README contents:

https://github.com/NixOS/ofborg?tab=readme-ov-file#automatic-building

Co-authored-by: Wolfgang Walther <walther@technowledgy.de>
Co-authored-by: Peder Bergebakken Sundt <pbsds@hotmail.com>
2025-08-07 19:27:55 +03:00
Wolfgang Walther 62fe016519
treewide: run treefmt with mdcr/nixfmt 2025-07-24 13:52:31 +02:00
Silvan Mosberger 98169225ad maintainers/scripts/update.nix: Run updateScript in development shell
Update scripts aren't always run in the development shell by default,
especially not in the regular automated updates.
The parent commit makes the update scripts depend on running in the
development shell, so let's make sure it's always done.
2025-07-18 19:03:12 +02:00
Gavin John d4963a3a58
pkgs/README: Clarify library dependent incluson criterion 2025-07-15 11:27:25 -04:00
Wolfgang Walther b4532efe93
**/README.md: one sentence per line
As documented in doc/README.md.
2025-06-29 21:14:32 +02:00
Wolfgang Walther 784eeb79fd
CONTRIBUTING: Add guideline to document motivation for special packaging choices (#416728) 2025-06-27 18:49:30 +00:00
Nikita Krasnov b598273a40
pkgs/README: suggest using git add -A
Suggest using `git add -A` instead of `git add .` as it is a little more robust.

https://stackoverflow.com/q/26042390/13749801
2025-06-23 14:14:30 +03:00
Peder Bergebakken Sundt 1f76e9b623
pkgs/README.md: require to specify the purpose of the patch (#416157) 2025-06-22 15:54:13 +02:00
aleksana 5c50f09871 pkgs/README.md: require to specify the purpose of the patch 2025-06-22 17:33:51 +08:00
Peder Bergebakken Sundt 0930b566b8 CONTRIBUTING: Add guideline to document motivation for special packaging choices
This helps with retaining domain knowledge, sorely needed during treewide fixups and bumps.
2025-06-19 01:58:35 +02:00
Aleksana f087265583
docs: fix fetchpatch2 example, warn about short hashes (#416950) 2025-06-16 11:28:06 +08:00
Nikita Krasnov b21cbbc953
pkgs/README: gtkspell was renamed into gspell
cbfb263ce1/pkgs/by-name/pa/pan/package.nix (L8)
2025-06-15 16:07:31 +03:00
FliegendeWurst 1e4f0c95f9 docs: fix fetchpatch2 example, warn about short hashes 2025-06-15 14:21:25 +02:00
Wolfgang Walther cd9e91d8cb
CONTRIBUTING: Add guideline to verify package upstreams (#406722) 2025-06-01 14:15:44 +00:00
Arne Keller 7dfb68eb83
adobe-reader: drop (#411841) 2025-05-31 12:39:25 +02:00
zimward 80d5523ade
adobe-reader: drop 2025-05-31 11:15:52 +02:00
Gwenn Le Bihan 2f8b917c22
doc: mention adding maintainers must be done in a separate commit (#410292) 2025-05-26 20:49:53 +08:00
Thomas Gerbet fbb150fb79
pkgs/README: Document security expectations for new packages (#405187) 2025-05-19 10:19:47 +02:00
Grimmauld 6cd1df5e59
pkgs/README: Document security expectations for new packages
Motivation: Many package additions add unmaintained or otherwise problematic packages.
Many additions for browser forks, questionable encryption libraries or 10+ years unmaintained software exist.
These are frequently closed, but the expectations are not actually visibly documented.
2025-05-17 13:49:08 +02:00
Jörg Thalheim a854493fc2
docs: replace fetchpatch with fetchpatch2 (#406131) 2025-05-13 14:18:16 +02:00
Peder Bergebakken Sundt 06296f6b11 CONTRIBUTING: Add guideline to verify package upstreams 2025-05-13 11:17:43 +02:00
Jörg Thalheim 1bf8b9e5d5 docs: replace fetchpatch with fetchpatch2 2025-05-11 12:00:24 +02:00
Marcin Serwin 406ea5c089 CONTRIBUTING: allow fetching unaccepted changes if the URL is stable
Reword documentation to allow using `fetchpatch` for changes that are
not yet merged upstream. Additionally, put a greater emphasis on URL
stability.

fixes #400873
2025-05-10 21:06:07 +02:00
Sam Estep 990b3e32ec
pkgs/README: fix typo 2025-03-20 00:26:29 +05:30
Sandro d325772e9e pkgs: write down that meta should be last 2025-03-05 10:28:51 +05:30
Silvan Mosberger b72bbe662b docs: Fix some links
Discovered with xrefcheck
2025-02-13 21:14:28 +01:00
David Chocholatý 6c61e588d3
docs: Fix relative links to packages moved to /by-name/ 2025-01-16 20:39:54 +01:00
Adam Dinwoodie bb72703fd9 docs: remove outdated references to CODEOWNERS
As of b01ca00aed (CODEOWNERS: Switch to alternate mechanism,
2024-10-10) and #336261, this repository doesn't use the GitHub
CODEOWNERS file, but instead has its own similar mechanism.  Remove and
update references to the CODEOWNERS file in various documentation files.
2024-12-30 22:08:49 +00:00
Ben 20b8eb5f55
pkgs/README.md: pkg version shall not be changed after patches (#363964) 2024-12-12 15:02:21 +08:00
Aleksana c3c2032ecb
pkgs/README.md: minor refactor to patch section to improve readability (#361688) 2024-12-04 09:58:19 +01:00
K900 c0dfdd22db pkgs/README: fix reference to deleted GMP version 2024-10-29 09:18:11 +03:00
Samuel Tardieu 1e4395e769 docs: fix typo "derivaton" → "derivation" (×3) 2024-10-28 13:29:09 +01:00
Samuel Tardieu 4592e9f5c1 README.md: mention that → can be used to signal version upgrades
Almost 1% of contributions in nixpkgs already use the unicode "→"
character instead of the two "->" ASCII characters to signal
a version upgrade. The guide only mentions "->", which sometimes
triggers discussions about the acceptable characters to use in
commit messages, with often a reference to the current README.md.

Some people prefer to use "→" because, depending on the font, it might
have a more appealing visual aspect than "->" and look better aligned.
Some others prefer to only write using the ASCII character set and will
use "->", but nowadays everyone can display common unicode characters
such as "→". Let us make everyone happy by indicating that both kind of
arrows are acceptable.
2024-10-20 19:15:34 +02:00
con-f-use 602fa25bef
docs: fix links in "Automatic package updates" 2024-09-28 00:16:03 +02:00
aleksana ecbb896800 pkgs/README.md: classify and add rules to the naming convention
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-09-12 08:11:03 +02:00
Silvan Mosberger aec0d14834 treewide: Fix or remove some markdown links
Found using https://github.com/serokell/xrefcheck, which unfortunately
can't trivially be enforced in CI because we also have the manual markdown
files that need post-processing to be valid
2024-09-03 23:37:05 +02:00
Doron Behar 34445ddb2d pkgs/README: recommend & redirect to pkgs/by-name in versioning section 2024-08-18 16:46:48 +03:00
Gavin John 1d40b45af4 pkgs/README: Add second example of versioning 2024-08-07 18:28:19 +01:00
Anderson Torres b59dfac3c6 pkgs/README.md: cite adoption as an alternative 2024-06-17 10:00:13 -03:00
Travis A. Everett 9ff9bbdb34
doc: add stdenv passthru chapter (#315909)
* doc: add stdenv passthru chapter

Broad strokes:
- create the chapter
- move existing stdenv passthru coverage into it
- move out-of-place coverage of passthru.tests from the stdenv meta chapter into it
- (try to) apply 1-sentence-per-line to text I've touched
- add legacy anchors for everything moved
- update existing links to the new anchors
- add tentative motivating text
- make nixpkgs-internal links relative/branchless

razor: if it is only ever needed by contributors, which is likely if links
refer to the latest revision of the source code, then it's for
the contributor guide

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-06-11 10:51:03 +02:00
Alexis Hildebrandt f8c4a98e8e treewide: Remove the definite article from meta.description
nix run nixpkgs#silver-searcher -- -G '\.nix$' -0l 'description.*"([Tt]he)? ' pkgs \
  | xargs -0 nix run nixpkgs#gnused -- -i '' -Ee 's/(description.*")[Tt]he (.)/\1\U\2/'
2024-06-09 23:08:46 +02:00