-
Notifications
You must be signed in to change notification settings - Fork 212
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
Contribution guidelines shouldn't apply to repo/project names #47
Comments
Maybe modify this item so it is more clear that the naming conventions apply to the name given on the awesome list and it doesn't need to match the repo/library name exactly. Check #42 (comment) |
Yes I saw that and I'm trying to make a case why that's the wrong decision.
This isn't a "naming convention" per se because the project names are set
prior to submission. Project names already vary in so many other ways
(e.g. hyphens/underscores, acronym/no acronym, spaces) that this rule
doesn't help with consistency and has the disadvantage of making the names
wrong.
…On Mar 11, 2020 5:01 AM, "Iñigo Biedma" ***@***.***> wrote:
- Maintain consistent and correct naming (ex: reMarkable, not
remarkable or ReMarkable).
Maybe modify this item so it is more clear that the naming conventions
apply to the name given on the awesome list and it doesn't need to match
the repo/library name exactly. Check #42 (comment)
<#42 (comment)>
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#47?email_source=notifications&email_token=ABJT7YKA2PP4VKHV2W25TE3RG5OPPA5CNFSM4LFPYXFKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOO4TGY#issuecomment-597543323>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABJT7YLJHBBFTXCWHSXYLWLRG5OPPANCNFSM4LFPYXFA>
.
|
The initial thought behind this guideline was less practical and more or less an aesthetic decision, however, given that there are already numerous other naming inconsistencies, some of which you've already pointed out, and realizing that the practical benefits indeed outweigh the aesthetic benefits, I suppose you're right. Unless other members of the reHackable group disagree with me, I suggest I'll edit the list once I find some time (and honestly motivation) to do so. PR's would obviously be appreciated as well. |
Originally posted by @asciiphil in #127 (comment) Let's track it here |
The contribution guidelines are good, but it doesn't make sense for them to apply to the repo names. In Python, modules are case sensitive and usually lowercase. This is how my projects appear on PyPi (
remarkable_mouse
,remarkable_keyboard
,remarkable_entware
,remarkable_pdflets
).It's also unclear how to apply this rule to projects like
remt
,rmapi
,rmsync
,rmtabletdriver
, etc.I recommend we restrict these guidelines to the description for each submission and let the authors decide how their project is stylized.
The text was updated successfully, but these errors were encountered: