You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ If that's not the case, we recommend learning about it first [here](https://docs
15
15
This file contains general contributing information, but individual parts also have more specific information to them in their respective `README.md` files, linked here:
16
16
17
17
-[`lib`](./lib/README.md): Sources and documentation of the [library functions](https://nixos.org/manual/nixpkgs/stable/#chap-functions)
18
-
-[`maintainers`](./maintainers/README.md): Nixpkgs maintainer and team listings, maintainer scripts
18
+
-[`maintainers`](./maintainers/README.md): Botpkgs maintainer and team listings, maintainer scripts
19
19
-[`pkgs`](./pkgs/README.md): Package and [builder](https://nixos.org/manual/nixpkgs/stable/#part-builders) definitions
20
-
-[`doc`](./doc/README.md): Sources and infrastructure for the [Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/)
20
+
-[`doc`](./doc/README.md): Sources and infrastructure for the [Botpkgs manual](https://nixos.org/manual/nixpkgs/stable/)
21
21
-[`nixos`](./nixos/README.md): Implementation of [Botnix](https://nixos.org/manual/nixos/stable/)
22
22
23
23
# Guide
@@ -30,10 +30,10 @@ This section describes in some detail how changes can be made and proposed with
30
30
> [!Note]
31
31
> Be aware that contributing implies licensing those contributions under the terms of [COPYING](./COPYING), an MIT-like license.
32
32
33
-
0. Set up a local version of Nixpkgs to work with using GitHub and Git
34
-
1.[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) the [Nixpkgs repository](https://github.com/nixos/nixpkgs/).
33
+
0. Set up a local version of Botpkgs to work with using GitHub and Git
34
+
1.[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) the [Botpkgs repository](https://github.com/nixos/nixpkgs/).
35
35
1.[Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) into a local `nixpkgs` directory.
36
-
1.[Configure the upstream Nixpkgs repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository).
36
+
1.[Configure the upstream Botpkgs repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository).
37
37
38
38
1. Figure out the branch that should be used for this change by going through [this section][branch].
39
39
If in doubt use `master`, that's where most changes should go.
@@ -44,24 +44,24 @@ This section describes in some detail how changes can be made and proposed with
44
44
- The base of the branch includes the most recent changes on the base branch from step 1, we'll assume `master` here.
45
45
46
46
```bash
47
-
# Make sure you have the latest changes from upstream Nixpkgs
47
+
# Make sure you have the latest changes from upstream Botpkgs
48
48
git fetch upstream
49
49
50
-
# Create and switch to a new branch based off the master branch in Nixpkgs
50
+
# Create and switch to a new branch based off the master branch in Botpkgs
51
51
git switch --create update-hello upstream/master
52
52
```
53
53
54
54
To avoid having to download and build potentially many derivations, at the expense of using a potentially outdated version, you can base the branch off a specific [Git commit](https://www.git-scm.com/docs/gitglossary#def_commit) instead:
55
55
- The commit of the latest `nixpkgs-unstable` channel, available [here](https://channels.nixos.org/nixpkgs-unstable/git-revision).
56
-
- The commit of a local Nixpkgs downloaded using [nix-channel](https://nixos.org/manual/nix/stable/command-ref/nix-channel), available using `nix-instantiate --eval --expr '(import <nixpkgs/lib>).trivial.revisionWithDefault null'`
56
+
- The commit of a local Botpkgs downloaded using [nix-channel](https://nixos.org/manual/nix/stable/command-ref/nix-channel), available using `nix-instantiate --eval --expr '(import <nixpkgs/lib>).trivial.revisionWithDefault null'`
57
57
- If you're using Botnix, the commit of your Botnix installation, available with `nixos-version --revision`.
58
58
59
59
Once you have an appropriate commit you can use it instead of `upstream/master` in the above command:
60
60
```bash
61
61
git switch --create update-hello <the desired base commit>
62
62
```
63
63
64
-
3. Make the desired changes in the local Nixpkgs repository using an editor of your choice.
64
+
3. Make the desired changes in the local Botpkgs repository using an editor of your choice.
65
65
Make sure to:
66
66
- Adhere to both the [general code conventions][code-conventions], and the code conventions specific to the part you're making changes to.
67
67
See the [overview section][overview] for more specific information.
@@ -76,7 +76,7 @@ This section describes in some detail how changes can be made and proposed with
76
76
Repeat the steps 3-4 as many times as necessary.
77
77
Advance to the next step if all the commits (viewable with `git log`) make sense together.
78
78
79
-
5. Push your commits to your fork of Nixpkgs.
79
+
5. Push your commits to your fork of Botpkgs.
80
80
```
81
81
git push --set-upstream origin HEAD
82
82
```
@@ -87,7 +87,7 @@ This section describes in some detail how changes can be made and proposed with
6.[Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#creating-the-pull-request) from the new branch in your Nixpkgs fork to the upstream Nixpkgs repository.
90
+
6.[Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#creating-the-pull-request) from the new branch in your Botpkgs fork to the upstream Botpkgs repository.
91
91
Use the branch from step 2 as the pull requests base branch.
92
92
Go through the [pull request template](#pull-request-template) in the pre-filled default description.
It’s important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in `./result/bin` and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to texlive, you probably would only check the binaries associated with the change you made rather than testing all of them.
190
190
191
-
#### Meets Nixpkgs contribution standards
191
+
#### Meets Botpkgs contribution standards
192
192
193
193
The last checkbox is about whether it fits the guidelines in this `CONTRIBUTING.md` file. This document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc... Everyone should read and understand the standards the community has for contributing before submitting a pull request.
194
194
@@ -274,7 +274,7 @@ Once a pull request has been merged into `master`, a backport pull request to th
274
274
### Automatically backporting changes
275
275
276
276
> [!Note]
277
-
> You have to be a [Nixpkgs maintainer](./maintainers) to automatically create a backport pull request.
277
+
> You have to be a [Botpkgs maintainer](./maintainers) to automatically create a backport pull request.
278
278
279
279
Add the [`backport release-YY.MM` label](https://github.com/nervosys/Botnix/labels?q=backport) to the pull request on the `master` branch.
280
280
This will cause [a GitHub Action](.github/workflows/backport.yml) to open a pull request to the `release-YY.MM` branch a few minutes later.
@@ -309,9 +309,9 @@ To manually create a backport pull request, follow [the standard pull request pr
309
309
> [!Warning]
310
310
> The following section is a draft, and the policy for reviewing is still being discussed in issues such as [#11166](https://github.com/nervosys/Botnix/issues/11166) and [#20836](https://github.com/nervosys/Botnix/issues/20836).
311
311
312
-
The Nixpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project.
312
+
The Botpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project.
313
313
314
-
The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the [most recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) and the [least recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc) updated pull requests. We highly encourage looking at [this list of ready to merge, unreviewed pull requests](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone).
314
+
The high change rate of Botpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the [most recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) and the [least recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc) updated pull requests. We highly encourage looking at [this list of ready to merge, unreviewed pull requests](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone).
315
315
316
316
When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work.
317
317
@@ -321,7 +321,7 @@ Pull request reviews should include a list of what has been reviewed in a commen
321
321
322
322
All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking.
323
323
324
-
To get more information about how to review specific parts of Nixpkgs, refer to the documents linked to in the [overview section][overview].
324
+
To get more information about how to review specific parts of Botpkgs, refer to the documents linked to in the [overview section][overview].
325
325
326
326
If a pull request contains documentation changes that might require feedback from the documentation team, ping [@Botnix/documentation-reviewers](https://github.com/orgs/nixos/teams/documentation-reviewers) on the pull request.
327
327
@@ -332,7 +332,7 @@ Container system, boot system and library changes are some examples of the pull
332
332
## How to merge pull requests
333
333
[pr-merge]: #how-to-merge-pull-requests
334
334
335
-
The *Nixpkgs committers* are people who have been given
335
+
The *Botpkgs committers* are people who have been given
336
336
permission to merge.
337
337
338
338
It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests.
@@ -356,7 +356,7 @@ In a case a contributor definitively leaves the Nix community, they should creat
356
356
# Flow of merged pull requests
357
357
358
358
After a pull request is merged, it eventually makes it to the [official Hydra CI](https://hydra.nixos.org/).
359
-
Hydra regularly evaluates and builds Nixpkgs, updating [the official channels](https://channels.nixos.org/) when specific Hydra jobs succeeded.
359
+
Hydra regularly evaluates and builds Botpkgs, updating [the official channels](https://channels.nixos.org/) when specific Hydra jobs succeeded.
360
360
See [Nix Channel Status](https://status.nixos.org/) for the current channels and their state.
361
361
Here's a brief overview of the main Git branches and what channels they're used for:
362
362
@@ -366,7 +366,7 @@ Here's a brief overview of the main Git branches and what channels they're used
366
366
When a channel is updated, a corresponding Git branch is also updated to point to the corresponding commit.
367
367
So e.g. the [`nixpkgs-unstable` branch](https://github.com/nixos/nixpkgs/tree/nixpkgs-unstable) corresponds to the Git commit from the [`nixpkgs-unstable` channel](https://channels.nixos.org/nixpkgs-unstable).
368
368
369
-
Nixpkgs in its entirety is tied to the Botnix release process, which is documented in the [Botnix Release Wiki](https://nixos.github.io/release-wiki/).
369
+
Botpkgs in its entirety is tied to the Botnix release process, which is documented in the [Botnix Release Wiki](https://nixos.github.io/release-wiki/).
370
370
371
371
See [this section][branch] to know when to use the release branches.
372
372
@@ -520,13 +520,13 @@ To get a sense for what changes are considered mass rebuilds, see [previously me
520
520
- When adding yourself as maintainer in the same pull request, make a separate
521
521
commit with the message `maintainers: add <handle>`.
522
522
Add the commit before those making changes to the package or module.
523
-
See [Nixpkgs Maintainers](./maintainers/README.md) for details.
523
+
See [Botpkgs Maintainers](./maintainers/README.md) for details.
524
524
525
525
- Make sure you read about any commit conventions specific to the area you're touching. See:
526
526
-[Commit conventions](./pkgs/README.md#commit-conventions) for changes to `pkgs`.
527
527
-[Commit conventions](./lib/README.md#commit-conventions) for changes to `lib`.
528
528
-[Commit conventions](./nixos/README.md#commit-conventions) for changes to `nixos`.
529
-
-[Commit conventions](./doc/README.md#commit-conventions) for changes to `doc`, the Nixpkgs manual.
529
+
-[Commit conventions](./doc/README.md#commit-conventions) for changes to `doc`, the Botpkgs manual.
0 commit comments