search

kashishmadan / oss-enterprise

Open Source in the Enterprise- All stuff from GitHub Learning Lab
https://lab.github.com/githubtraining/create-an-open-source-program
2 stars 0 forks source link

Add contributing guidelines #3

Closed github-learning-lab[bot] closed 5 years ago

github-learning-lab[bot] commented 5 years ago

Step 3: Add a CONTRIBUTING.md to your organization's open source repository

This pull request introduces a CONTRIBUTING.md template file.

This template should be used in all of your organization's repositories and be customized by the maintainers. The CONTRIBUTING.md file communicates expectations with contributors about how they can help contribute to the project.

The CONTRIBUTING.md file should be customized for each project as much as possible to be clear and helpful. If contributors aren't sure what to do, their contributions won't be as useful to the project. This often results in inconsistent contributions and longer than needed review time from maintainers before merging.

If you're looking for inspiration, here are some great examples of CONTRIBUTING.md files from notable projects. :sparkles:

:keyboard: Action: Improve the guide to contributing

  1. Look through the examples listed above, and make note of qualities you like (or don't like) about each document.
  2. Change the document in this pull request so it is a good template for all other repositories in your organization.
  3. Commit directly to this branch. When you're ready to move on, merge this pull request.

I'll respond when you merge this pull request.

kashishmadan commented 5 years ago

Hey there coder!

Well, thanks for visiting this and I would really appreciate you to contribute to this open source codebase but it isn't really of use right now!

Let me finish up with this tutorial which is forcing me to write the content of the CONTRIBUTING.md file and I will update this later.

github-learning-lab[bot] commented 5 years ago

Great! Let's go to the next step.