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

chore: rename DEVELOPMENT to CONTRIBUTING #488

Merged
merged 1 commit into from
Sep 27, 2023
Merged

Conversation

SethFalco
Copy link
Contributor

@SethFalco SethFalco commented Sep 17, 2023

Feel free to close this, but just a proposal.

Could the DEVELOPMENT.md file please be renamed to either CONTRIBUTING.md or HACKING.md? I actually missed it at first and was working on one until I noticed the DEVELOPMENT file. ^-^'

There likely are other projects that use the term DEVELOPMENT, but this is the first I've seen it. Meanwhile, CONTRIBUTING and HACKING are normalized across open-source projects and even platforms like GitHub, GitLab, etc.

To make your contributing guidelines visible in the repository's root directory, type CONTRIBUTING.

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#adding-a-contributing-file

Here you can see GitHub recommends people to read it the first time they contribute, and it'll always be on the side when opening a PR under Helpful resources when named this way. At the moment it's not listed since GitHub doesn't recognize DEVELOPMENT.md as a resource for contributors.

Here you can see if GitLab finds a CONTRIBUTING.md file, it will add a badge to bring it to the users attention.

@kingdonb
Copy link
Collaborator

Thanks for pointing this out! It should be straightforward to merge this, let's take a look tomorrow when I'm fully awake 🤤

@juozasg juozasg merged commit 10b3453 into weaveworks:main Sep 27, 2023
1 check passed
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