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

CONTRIBUTING.md should not be a git tutorial #6

Open
meowsbits opened this issue Jun 6, 2019 · 5 comments
Open

CONTRIBUTING.md should not be a git tutorial #6

meowsbits opened this issue Jun 6, 2019 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@meowsbits
Copy link

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
Copy link
Owner

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
Copy link
Author

Nope. That is also a git tutorial.

@cyrilou242
Copy link

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

@race2infinity race2infinity added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 10, 2019
@LuluNwenyi
Copy link

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
Copy link
Owner

The CONTRIBUTING.md file is still there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants