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

pkgs/README.md: classify and add rules to the naming convention #340452

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

Aleksanaa
Copy link
Member

@Aleksanaa Aleksanaa commented Sep 8, 2024

Description of changes

This is noticed in NixOS/nixpkgs-vet#107, and we should explicitly tell contributors how to deal with variables starting with a digit.

Rendered


Add a 👍 reaction to pull requests you find important.

@Aleksanaa Aleksanaa force-pushed the package-attribute-doc branch 3 times, most recently from 3868537 to 165cf93 Compare September 8, 2024 07:41
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux labels Sep 8, 2024
pkgs/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in favor of the semantic change. Thanks for taking the time @Aleksanaa!

Left a bunch of purely formal suggestions.

pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/by-name/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
@Aleksanaa Aleksanaa force-pushed the package-attribute-doc branch 5 times, most recently from 164d67d to 0a34185 Compare September 11, 2024 11:52
@Aleksanaa
Copy link
Member Author

@fricklerhandwerk Would you give a final review? It looks good from my side now.

I'd also like to refactor more of this README to make the structure clear, but I don't want to expand the scope of this PR too much

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have more clarifications for this document, I'm glad to review those, too. This is a dense text and it doesn't exactly make contributions easier if you want to follow all the rules.

@Aleksanaa Aleksanaa marked this pull request as draft September 11, 2024 15:44
@Aleksanaa
Copy link
Member Author

This is what I had in mind. IMO it's logically better, but conventions goes to bottom and I'm afraid less people would carefully read it (there's side pane on GitHub tho). I didn't modify most of texts here, just rearranging it, so the wording problem should be omitted. Only this is newly added:

The pkg-name shall be the top-level attribute name used for the package, such as python3Packages.setuptools-rust, nixVersions.nix_2_24 and alpaca. This is to trigger ofborg build on the package added or modified.

I have to go to sleep now. It would be helpful if you can express a brief opinion on this. Thanks!

@fricklerhandwerk
Copy link
Contributor

Oh, slight misunderstanding... let's do further changes in a follow up PR. I was ready to merge this.

pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
pkgs/README.md Outdated Show resolved Hide resolved
@Aleksanaa Aleksanaa marked this pull request as ready for review September 12, 2024 00:29
@Aleksanaa
Copy link
Member Author

@fricklerhandwerk dropped

@fricklerhandwerk fricklerhandwerk merged commit 8ef21e8 into NixOS:master Sep 12, 2024
31 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants