Suggestion: add contribution guidelines
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 5.3k
- Forks
- 510
- Avg merge
- 8d 5h
- Merged PRs (30d)
- 5
Description
Sometimes pull-requests contain unecessary changes (e.g #147).
It could be a good idea to help contributors what is expected of them by adding a clear contribution guidelines document. I always like to refer this great post by @migueldeicaza: http://tirania.org/blog/archive/2010/Dec-31.html as I myself fell into this trap more than once on different projects (not all open-source).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review pull request #147 and the linked contribution-guidelines post first. Then identify the repository's documentation conventions and define a contribution guidelines document covering expected pull-request changes. Done means the guidelines are added in an appropriate location and clearly explain contributor expectations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100