diff options
| author | Romain GARBAGE <romain.garbage@inria.fr> | 2026-02-23 10:31:30 +0100 |
|---|---|---|
| committer | Romain GARBAGE <romain.garbage@inria.fr> | 2026-02-25 09:12:38 +0100 |
| commit | 3e40f81759c08564ea1a46da8c1a6d9a160b3b96 (patch) | |
| tree | 7f8d40e5ec3eac2c2a58964f32e90e853460bf64 /README.rst | |
| parent | 9e60ba9b8e19fe9bf4a001a1975642b4460b566f (diff) | |
README: Refactor Contributing/Hacking this repository sections.
* README.rst: Move guix lint/packaging guideline bits from the
Contributing section to the Hacking this repository section.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 24 |
1 files changed, 12 insertions, 12 deletions
| @@ -88,18 +88,6 @@ Submissions of unfinished packaging attempts are welcome as well, as there is | |||
| 88 | a good chance that others can help finish the work. Please prefix pull requests | 88 | a good chance that others can help finish the work. Please prefix pull requests |
| 89 | for unfinished contributions with WIP. | 89 | for unfinished contributions with WIP. |
| 90 | 90 | ||
| 91 | When submitting a new package or a modification to a package, make sure to run: | ||
| 92 | |||
| 93 | .. code:: console | ||
| 94 | |||
| 95 | guix lint -L /path/to/your/guix/science/checkout <package-name> | ||
| 96 | |||
| 97 | This repository follows Guix's `Packaging Guidelines`_, refer to them | ||
| 98 | when contributing. | ||
| 99 | |||
| 100 | .. _Packaging Guidelines: | ||
| 101 | https://guix.gnu.org/manual/devel/en/html_node/Packaging-Guidelines.html | ||
| 102 | |||
| 103 | When obtaining a fresh checkout of this repository, run the following | 91 | When obtaining a fresh checkout of this repository, run the following |
| 104 | command: | 92 | command: |
| 105 | 93 | ||
| @@ -144,6 +132,18 @@ You can learn more about working with a channel in the `Guix manual`_. | |||
| 144 | 132 | ||
| 145 | .. _Guix manual: https://guix.gnu.org/manual/devel/en/html_node/Creating-a-Channel.html | 133 | .. _Guix manual: https://guix.gnu.org/manual/devel/en/html_node/Creating-a-Channel.html |
| 146 | 134 | ||
| 135 | When submitting a new package or a modification to a package, make sure to run: | ||
| 136 | |||
| 137 | .. code:: console | ||
| 138 | |||
| 139 | guix lint -L /path/to/your/guix/science/checkout <package-name> | ||
| 140 | |||
| 141 | This repository follows Guix's `Packaging Guidelines`_, refer to them | ||
| 142 | when contributing. | ||
| 143 | |||
| 144 | .. _Packaging Guidelines: | ||
| 145 | https://guix.gnu.org/manual/devel/en/html_node/Packaging-Guidelines.html | ||
| 146 | |||
| 147 | Deprecation policy | 147 | Deprecation policy |
| 148 | --------------------------------------- | 148 | --------------------------------------- |
| 149 | 149 | ||
