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

Contribution guidelines shouldn't apply to repo/project names #47

Open
Evidlo opened this issue Mar 11, 2020 · 4 comments
Open

Contribution guidelines shouldn't apply to repo/project names #47

Evidlo opened this issue Mar 11, 2020 · 4 comments

Comments

@Evidlo
Copy link
Contributor

Evidlo commented Mar 11, 2020

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.

@Ameb
Copy link
Member

Ameb commented Mar 11, 2020

  • 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)

@Evidlo
Copy link
Contributor Author

Evidlo commented Mar 11, 2020 via email

@CTXz
Copy link
Member

CTXz commented Apr 12, 2020

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.

@Ameb
Copy link
Member

Ameb commented Apr 30, 2021

Hm. I'd be willing to go through all of the projects and make sure their names match the authors' official capitalizations. Would you object to a PR with just those changes?

Originally posted by @asciiphil in #127 (comment)

Let's track it here

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

No branches or pull requests

3 participants