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

Rename HowToContribute.md to CONTRIBUTING.md #72

Open
ZakCodes opened this issue Apr 11, 2020 · 4 comments
Open

Rename HowToContribute.md to CONTRIBUTING.md #72

ZakCodes opened this issue Apr 11, 2020 · 4 comments

Comments

@ZakCodes
Copy link

There are certain files like the README.md that have the same name in every open source project. This is also the case for the CONTRIBUTING.md which you have named HowToContribute.md. You can see a list of those files here.

Not using the same name as every other project makes the file a bit harder to find for experienced users. However, for beginners I do understand that HowToContribute might be a little more obvious to them.

I think that a good compromise is to call the file CONTRIBUTING.md and add a section in the README.md called How to contribute that points the user to the CONTRIBUTING.md. This is what I usually do for my projects.

If you want a list of those standard file names in a repository, GitHub gives advice about that on this page.

Since you seem to be interested in learning about open source project management and interacting with the community, you could find some more useful information on [this page about building a strong community](Building a strong community). This page, which is part of the previous one, treats more specifically of how to set up a project for healthy contributions.

I think is great that you're getting into open source project into building a community. Very few open source project have the chance to have 15 contributors when they are only 41 commits in. Obviously you do deserve it because you've already created a community with your social media.
You could therefore take advantage of your visibility to make this a really great project that is a great example in terms of documentation and in terms of standardization to teach good principles to the beginners that might be interested in contributing to your project.

I think this project is a great idea and I wish you good luck!
P.S. I do realize that this is a really long issue message just to tell someone to change the name of a file lol

@l3str4nge
Copy link
Contributor

Agreed 🚀

@xkral-tr
Copy link

I did it.

@ZakCodes
Copy link
Author

@xkral-tr btw, in the description of your PR, you can write Closes #72 to automatically close this issue when your PR will be merged.
In the future, you can also put it in the commit that fixes the issue. See this for more info.

@xkral-tr
Copy link

@ZakCodes thanks

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