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

Clarify guidelines #4096

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify guidelines #4096

wants to merge 1 commit into from

Conversation

rayegun
Copy link
Member

@rayegun rayegun commented Nov 25, 2024

Clarify that according to the General README these are guidelines not rules, and as such may be overridden with sufficient justification.

Clarify that according to the General README these are guidelines *not* rules, and as such may be overridden with sufficient justification.
@rayegun
Copy link
Member Author

rayegun commented Nov 25, 2024

I believe this was changed at some point from guidelines to rules, given that there are broken links on General/README.md.

I am strongly in favor of maintaining the word guidelines, not the word rules. Names are by nature a deeply personal part of the package development process. With sufficient justification and/or rebuttals to community name feedback we should feel comfortable merging package author preferred names.

In addition it must be clear that renaming suggestions are suggestions. Users who point to Pkg.jl docs as "rules" rather than guidelines are empowered to outright deny names, rather than offer constructive suggestions. I receive frequent complaints about weaponization of the rules/guidelines from new and existing community members.

Explicitly stating that these are guidelines provides more support for package authors who feel they are being demanded to make changes rather than being suggested.

@KristofferC
Copy link
Member

KristofferC commented Dec 2, 2024

Was changed in JuliaLang/julia#53566. I agree that guidelines sounds better (which I said JuliaLang/julia#53566 (comment) :P)

@KristofferC
Copy link
Member

┌ Error: Cannot resolve @ref for md"[package naming rules](@ref Package-naming-rules)" in src/toml-files.md.
│ - No docstring found in doc for binding `Base.-`.

So I think the ref has to be updated in that other file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants