race2infinity/The-Documentation-Compendium

CONTRIBUTING.md should not be a git tutorial

meowsbits opened this issue · 5 comments

meowsbits commented

https://github.com/kylelobo/The-Documentation-Compendium/blob/d472f574099bf4fec09c2a843857a9b10dc0a40f/CONTRIBUTING.md

This is tutorial on how to use git. This has nothing to do with real-world project contribution guidelines that would be useful in the context of a working git project. There are far better "How to use git" tutorials out there, and this space should describe either

  • how to actually contribute to this repo, or
  • in general, a proposed education around the politics and conventions of contributing at large
race2infinity commented

Thanks for the feedback. Would you advocate this format?

  1. Fork it (https://github.com/kylelobo/The-Documentation-Compendium/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request
meowsbits commented

Nope. That is also a git tutorial.

  • 👍3
cyrilou242 commented

Maybe look for contributing README and pages of Apache projects. They are usually well made.
https://github.com/apache/spark/blob/master/CONTRIBUTING.md
https://spark.apache.org/contributing.html

  • 👍1
LuluNwenyi commented

Hi @kylelobo, I see that there's no longer a CONTRIBUTING.md file. May I ask why, and if I can create a new issue and be assigned to the issue?

race2infinity commented

The CONTRIBUTING.md file is still there