Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md: Add section on becoming a maintainer #171557

Closed
Mindavi opened this issue May 4, 2022 · 3 comments · Fixed by #250344
Closed

CONTRIBUTING.md: Add section on becoming a maintainer #171557

Mindavi opened this issue May 4, 2022 · 3 comments · Fixed by #250344
Labels
0.kind: enhancement Add something new

Comments

@Mindavi
Copy link
Contributor

Mindavi commented May 4, 2022

I got some feedback after a review on a PR (#161404 (comment)) that it's not very clear that adding yourself as a maintainer in maintainers.nix should be a separate commit.

It might be nice to add a small section to CONTRIBUTING explaining the (simple) process, or maybe linking from there to the manual.

@Mindavi Mindavi added the 0.kind: enhancement Add something new label May 4, 2022
@fabaff
Copy link
Member

fabaff commented May 5, 2022

The Nixpkgs Manual has that section.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Nov 2, 2022
@VuiMuich
Copy link
Contributor

Nevertheless the section in the manual is helpful, imo having a comment in CONTRIBUTING seems like a good idea.

Additionally I would suggest that both sources should mention that as per comment it might be preferrable to have the commits ordered like this:

maintainers: add <new-maintainer>
<package-name>: <commit message>

this also helps to easier squash required changes to the actual commit.

@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 25, 2023
VuiMuich added a commit to VuiMuich/nixpkgs that referenced this issue Aug 28, 2023
@fricklerhandwerk
Copy link
Contributor

Fixed by #248013 and #250344

@fricklerhandwerk fricklerhandwerk linked a pull request Sep 1, 2023 that will close this issue
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0.kind: enhancement Add something new
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants