summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
AgeCommit message (Collapse)AuthorFilesLines
3 daysdoc: Fix typo.Maxim Cournoyer1-1/+1
* doc/contributing.texi (Deprecation Policy): Add missing closing parenthesis.
2026-07-29doc: Update dependency URLs.fanquake1-2/+2
* doc/contributing.texi (Requirements): Update URLs. Merges: https://codeberg.org/guix/guix/pulls/10206 Signed-off-by: Nguyễn Gia Phong <cnx@loang.net>
2026-07-20doc: Document current policy for vendored code.Giacomo Leidi1-14/+77
* doc/contributing.texi (Dependencies Unbundling): New subsection. Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-07-11doc: Improve instructions to minimize unexpected test failures.Hugo Buddelmeijer1-17/+32
* doc/contributing.texi (Building from Git): Suggest `guix shell --pure` as that is currenlty the only way to make the tests pass on the first run. (Running the Test Suite): Explain which test failures are expected depending on each setup. Change-Id: I3425879dcd2a71c2e3c2fd00b55c819447ac9437 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Modified-by: Ludovic Courtès <ludo@gnu.org> Merges: #9408
2026-06-21doc: Remove Debbugs-related documentation.Maxim Cournoyer1-227/+0
We've been using Codeberg for more than a year now. Also delete email-flow related config files. * doc/contributing.texi (Tracking Bugs and Changes) <Debbugs User Interfaces>: Delete subsection. * .patman: Delete file. * .mumi/config: Likewise.
2026-06-19doc: Fix warnings.Maxim Cournoyer1-6/+2
* doc/contributing.texi (Deprecation Policy): Fix @table-related warnings.
2026-06-16doc: contributing: Recommand option --keyring of 'guix git authenticate'.Simon Tournier1-3/+3
* doc/contributing.texi (Building from Git): Remove mention to fetch the keyring branch from origin and replace by the option '--keyring'. Change-Id: I32fdf688329bb874210064ebfc814b14fdb35d17 Signed-off-by: Maxim Cournoyer <maxim@guixotic.coop>
2026-06-12Revert "build: Add a commit-msg hook that embeds Change-Id in commit messages."Maxim Cournoyer1-9/+1
This reverts commit 8005e09b261d65bf0f7469cd8e89423c1c1db820 and follow-ups. This was added 2 years ago to be able to trace commits between the git repository and the guix-patches tracker, and to implement a solution to automatically close merged commits (which has not materialized). Since we have now migrated to Codeberg, the cross-referencing between reviewed commits (pull requests) and the actual commits merged can be done in the Codeberg UI (via the 'manually merged' option), and Codeberg also supports closing a bug via the "Fixes: #NNN" git trailer, and as a convention we can add a "Merges: !NNN" git trailer in a commit closing a PR (the actual closing is not yet implemented by Forgejo), which mostly obsoletes the purpose of the Change-Id git trailer.
2026-06-05doc: Transcribe GCD 006.Andreas Enge1-31/+74
* doc/contributing.texi (Deprecation Policy): Update according to GCD 006. Change-Id: If48d74c8ed94f5040d842de03150a3ee673f841d
2026-06-03doc: Contributing: Direct issue reports to Codeberg.Rovanion Luckey1-6/+9
* doc/contributing.texi (Contributing): Direct issue reports to Codeberg instead of the deprecated bug-guix mail list. Change-Id: I5bd1b5926e144b8461ab2f836bed1319ae75ec88 Merges: https://codeberg.org/guix/guix/pulls/7814 Reviewed-by: Nicolas Graves <ngraves@ngraves.fr> Signed-off-by: Nguyễn Gia Phong <cnx@loang.net>
2026-05-25doc: Add agitjo under the ’perfect setup’ section.Cayetano Santos1-0/+27
This is a complement to the AGit workflow included in "Submitting Patches". * doc/guix.texi: Mention ‘emacs-agitjo’ in the ’Emacs’ subsection. Merges guix/guix!8445 Change-Id: Ia49a0da71e8b08e252ff4dd996c414173920ecac
2026-05-21doc: Remove footnote under “The Perfect Setup”.Cayetano Santos1-7/+1
This doesn’t hold true anymore. * doc/contributing.texi (The Perfect Setup)[Emacs]: Remove footnote. Change-Id: Iafe3bddad665c817eef463a264fcf3503f4a7691
2026-04-23doc: Recommend a way of resolving merge conflicts for rust PRs.Murilo1-0/+10
* doc/contributing.texi (Rust Crates) [Resolving merge conflicts in Pull Requests]: New subsubsection. Change-Id: Icbc5e2da01b6068b6237548f2bd49262433799de Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23doc: Add rust commit messages guidance.Murilo1-0/+52
* doc/contributing.texi (Rust Crates)[Commit messages]: New subsubsection. Change-Id: If22d6921301902417a88d2d5d8e2fad947762bee Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23doc: Clarify that rust crate changes should be done in the same commit.Murilo1-0/+3
* doc/contributing.texi (Rust Crates): Add clarification. Change-Id: Iff45cda11b14640a70a2849fe66ae68f46cb3ba9 Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-20doc: Mention the GCD process.Ludovic Courtès1-0/+21
* doc/contributing.texi (Making Decisions): Document GCDs. Change-Id: I8b247af4e6ec731bc7750e19519c8dba863e5ef5 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #7786
2026-03-14doc: Reintroduce mention of ‘bug-reference-mode’.Ludovic Courtès1-0/+29
* doc/contributing.texi (Emacs): Add @unnumberedsubsubsec commands. Add “Referencing Bug Reports” section. Change-Id: I21d7ecc022c00fc4d4cecf2273b1d46d8e770195 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #6614
2026-03-14doc: Document Emacs-Guix for development.Ludovic Courtès1-1/+8
* doc/contributing.texi (Emacs): Document Emacs-Guix. Change-Id: I921f77425706709e49094ee96b28e29e29ad6878 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-14doc: Move “Guile Studio” and “Vim and NeoVim” under “The Perfect ↵Ludovic Courtès1-27/+58
Setup”. * doc/contributing.texi (The Perfect Setup): Add introduction. Move former body to … (Emacs): … this. (Alternative Setups): Remove. (Guile Studio, Vim and NeoVim): Move under “The Perfect Setup”. Change judgmental sentence. Change-Id: I149d418ac17a2283ad3452213b7425be4a8893f4 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-14doc: Remove “Viewing Bugs within Emacs”.Ludovic Courtès1-83/+2
This is a followup to d499253d47cca2694944c5fd1f4b582e5206890a and related commits. * doc/contributing.texi (Viewing Bugs within Emacs): Remove. (Debbugs User Interfaces): Refer to the ‘debbugs-ug’ manual. Change-Id: Idddff940302efe5689c8b459e0b141acaae74395 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-14doc, gnu: Update URL of several packages formerly at notabug.org.Ludovic Courtès1-5/+5
The URL change for these 5 packages was announced at <https://lists.gnu.org/archive/html/guile-user/2026-03/msg00000.html>. * doc/contributing.texi (Requirements): Update URLs. * gnu/packages/gnupg.scm (guile-gcrypt)[home-page]: Update. * gnu/packages/guile.scm (guile-sqlite3)[home-page]: Update. (guile-zlib)[source]: Update URL and hash. [home-page]: Update. (guile-lzlib)[home-page]: Update. (guile-zstd)[home-page]: Update. * m4/guix.m4 (GUIX_CHECK_GUILE_SQLITE3): Update commit URL. Merges guix/guix!7069 Change-Id: Ic587d3e2dcd931a44c007d9cdcd0b20e771be33b Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-03-08doc: Remove mention of python-toolchain.Sharlatan Hellseher1-2/+1
* doc/contributing.texi (Python Moduels): Drop mention of python-toolchain. * guix/build-system/pyproject.scm: Likewise. Fixes: guix/guix#5841 Change-Id: I39a1ec7ce6da2e5f3298323b36070c3e3b197669
2026-03-03doc: Refresh python documentation.Nicolas Graves1-40/+33
* doc/contributing.texi: Refresh python documentation (avoid uses of "we " and "you", remove the reference to pyproject-build-system as experimental, and adjust the setuptools situation comments). Merges: https://codeberg.org/guix/guix/pulls/6427 Change-Id: Idb065befc975063ad97e6bdafb724e50d6891cb5 Reviewed-by: Yan Abu Arab <yanabuarab@gmail.com> Reviewed-by: Maxim Cournoyer <maxim@guixotic.coop> Signed-off-by: Sharlatan Hellseher <sharlatanus@gmail.com>
2026-02-03doc: Document “standard” pull requests and AGit.Ludovic Courtès1-0/+41
* doc/contributing.texi (Submitting Patches): Document “standard” pull requests and AGit. Merges guix/guix!5840 Change-Id: I8fe93e4dde0b9543f3bd99c66cf1fdb6ba69c449 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Remove “Debbugs Usertags” section.Ludovic Courtès1-59/+1
* doc/contributing.texi (Debbugs Usertags): Remove. Merges guix/guix!5840 Change-Id: If550e31918c495ed24578fcbaaa179eb36521687 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Update Debbugs deprecation warnings.Ludovic Courtès1-19/+12
* doc/contributing.texi (The Issue Tracker): Update deprecation notice. (Debbugs User Interfaces): Likewise. Merges guix/guix!5840 Change-Id: Ic5c1bddddbb8c53b031d52887f57372759badf8b Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Remove “Sending a Patch Series” section.Ludovic Courtès1-161/+0
* doc/contributing.texi (Sending a Patch Series): Remove. Merges guix/guix!5840 Change-Id: I8f15c4385b24cecc6a8f1bd13c2065d2a267e5b1 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-02-03doc: Contributions are now made on Codeberg.Ludovic Courtès1-45/+9
* doc/contributing.texi (Submitting Patches): Document Codeberg pull requests as the only method. Mention guix-patches@gnu.org in a footnote. Remove paragraphs about of ‘git send-email’ and the associated workflow. Merges guix/guix!5840 Reported-by: Nick Blumenauer <nicknb@posteo.com> Change-Id: Ifbd46665a14a83f014ddff4234cc69bf93c3a8d1 Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-01-27serialization: Use ‘bytevector-slice’ from Guile >= 3.0.9.Ludovic Courtès1-1/+1
* guix/serialization.scm (sub-bytevector): Remove. (read-byte-string): Use ‘bytevector-slice’. * configure.ac: Require Guile 3.0.9. * doc/contributing.texi (Requirements): Adjust accordingly. Change-Id: I7aa11a2182530ea5131be591db03b17efb6847a4 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #4495
2026-01-05doc: Better explain extra development tools when building from git.Hugo Buddelmeijer1-3/+3
* doc/contributing.texi (Building from Git): Better explain adding tools. Change-Id: I47fb9e5414edc5eebce64d25db6998cc51985fcb Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #4821
2026-01-05doc: Explain that some test require network when building from git.Hugo Buddelmeijer1-0/+4
* doc/contributing.texi (Building from Git): Discuss network tests. Change-Id: I21c8e4a1e60ed215a6fb3507b7aedc1835f735ad Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-01-05doc: Improve building from git instructions.Hugo Buddelmeijer1-0/+2
* doc/contributing.texi (Building from Git): Improve instructions. Include 'cd' and authorizing the directory for guix shell. Change-Id: Ied8eb7553ab92504a87c0059820ca154a18c33ab Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-12-23doc: Briefly discuss default git branch name.Hugo Buddelmeijer1-1/+5
* doc/contributing.texi (Building from git): Discuss branch name. Change-Id: I9ddb9318749c7974a8724355c1a6b18a98fa9e8e Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2025-10-23doc: Recommend ‘define-deprecated-package’ in the Deprecation Policy.Ludovic Courtès1-5/+13
* doc/contributing.texi (Deprecation Policy): Document and recommend ‘define-deprecated-package’. Change-Id: I530310f5216f09025525d91f690bb3885fe2cfb4
2025-09-23doc: Clarify how to create the Codeberg token for `sync-codeberg-teams'.Maxim Cournoyer1-2/+4
* doc/contributing.texi (Teams): Mention needed permissions and provide the page URL. Change-Id: I4ba44379a4ce5df9e987b32f28ebac0c7dc35618
2025-09-16doc: Remove broken link.Gabriel Wicki1-6/+3
* doc/contributing.texi: Delete sentence with broken link. Change-Id: I2f0b67e1fa70750414e30d7cd474e1d4d077d9e8
2025-08-28doc: Add link to issues and pull requests with the ‘deprecation’ label.Ludovic Courtès1-1/+7
* doc/contributing.texi (Deprecation Policy): Add note with link to issues and pull requests with the ‘deprecation’ label. Change-Id: If5e833e20c11796f961f48e086c54fdbb9155dd1
2025-08-23doc: Increase minimum Guile-Git version.Morgan Arnold1-1/+1
* doc/contributing.text: bump minimum required version of guile-git from 0.5.0 to 0.10.0, required by 86022e994e. * po/doc/guix-manual.*: update translations as well. Change-Id: I8cc8fd720cc71fbe17e2e530f7411b9c888ba0f6 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-08-21doc: Document lockfile importer based Rust packaging workflow.Hilton Chain1-28/+72
* doc/guix.texi (Build Systems) [cargo-build-system]: Add cross-reference for the term "Cargo workspaces". * doc/contributing.texi (Packaging Guidelines)[Rust Crates]: Update documentation. * doc/guix-cookbook.texi (Packaging)[Packaging Workflow]: New section. * gnu/packages/rust-crates.scm, * gnu/packages/rust-sources.scm: Stop mentioning guix-rust-registry for now, we may remove the repository if future merges are managed well. Change-Id: Ic0c6378cf5f5df97d6f8bdd040b486be62c7bddc
2025-08-06doc: Fix some typos.Efraim Flashner1-1/+1
* doc/contributing.texi (Bulk Updates): Fix typo. * doc/guix.texi (Networking Services, Power Management Services, Guix Services, Backup Home Services): Same. Change-Id: I4ebde33ad628e35ea2c1888b8247707ab3763cf1
2025-07-12doc: Fix some grammar.cdr-shdr-wdr1-5/+5
* doc/contributing.texi (Alternative Setups): Fix grammar, add double space. (Sending a Patch Series): Add missing word. * doc/guix.texi (Daemon Offload Setup, Invoking guix repl): Fix grammar. (Bootloader Configuration): Fix grammar, capitalize "RAM". Change-Id: I459c8343b28b2b3474c7a54372f75c61c8111a10 Signed-off-by: Danny Milosavljevic <dannym@friendly-machines.com>
2025-07-09doc: Update weblate URL.Julien Lepiller1-6/+5
* doc/build.scm (stylized-html): Update URL from fedora to codeberg's Weblate. * doc/contributing.texi: idem. * doc/guix-cookbook.texi: idem. * doc/guix.texi: idem. Change-Id: I13729a73f94738c9c336a067058020549f2640d6
2025-07-01doc: More typographical tweaks for “Bulk Updates” section.Ludovic Courtès1-7/+7
* doc/contributing.texi (Bulk Updates): Capitalize title. Leave two spaces after end-of-sentence period. Use @dots{} instead of showing full store file names, as per ‘assert-no-store-file-names’ target. Fix typo. Change-Id: Iceb0079ec35fda95280afff1c0d4b2cd84717b96
2025-07-01doc: contributing: Correct typos in Bulk updates.Sergey Trofimov1-13/+13
* doc/contributing.texi (Bulk updates): Correct typos. Change-Id: I660520b64139537e6ca9186c06810f5053d4368e Signed-off-by: Ludovic Courtès <ludo@gnu.org> Modified-by: Ludovic Courtès <ludo@gnu.org>
2025-06-23doc: contributing: Fix broken example.Jelle Licht1-1/+1
* doc/contributing.texi (Bulk updates): Properly escape special characters. Change-Id: I9aa4d88f19904056546717cd80ca89ab2f5924fe
2025-06-23doc: Document bulk updates.Sharlatan Hellseher1-0/+35
* doc/contributing.texi (Bulk updates): New section describing update technique for collection of packages. Change-Id: Ic67978a6c8e0140980a0ede968f7e411faf23a1d Signed-off-by: jgart <jgart@dismail.de>
2025-06-12doc: Fix typo.Ludovic Courtès1-1/+1
* doc/contributing.texi (The Issue Tracker): Fix typo. Change-Id: Ibcc93fa13bcb8a5bc902e6ce743b43b7973608e4
2025-06-09doc: Document ‘etc/teams.scm sync-codeberg-teams’.Ludovic Courtès1-2/+19
* doc/contributing.texi (Teams): Document ‘sync-codeberg-teams’. Change-Id: I0a32c78b26f3687ed744a29a9d768b5ee597d932
2025-06-09doc: Mention Codeberg issues and pull requests.Ludovic Courtès1-21/+65
* doc/contributing.texi (Submitting Patches): Describe the two options, Codeberg and Debbugs. (Sending a Patch Series): Add deprecation warning. (The Issue Tracker): Mention Codeberg. (Managing Patches and Branches): Remove initial reference to guix-patches. (Debbugs User Interfaces): Add deprecation warning. (Reviewing the Work of Others): Mention pull request approval. Change-Id: Ibf21e8923e555db1e14107ad87a65bf45f9f3fc3
2025-06-06doc: contributing: Disable authentication when simulating ‘guix pull’.Hilton Chain1-1/+1
* doc/contributing.texi (Submitting Patches): Add ‘--disable-authentication’ when simulating ‘guix pull’. * .forgejo/pull_request_template.md: Likewise. Fixes: #427 Change-Id: I4c6847314c8876a2f6e29f938cbbbe286178231b