Add CONTRIBUTING.md #3454
Add CONTRIBUTING.md #3454
Conversation
CONTRIBUTING.md
Outdated
| #### Environment setup | ||
|
|
||
| 0. Install Node.js (4 or newer) and npm (3 or newer). | ||
| 1. Fork Swagger-UI, and clone your fork. |
There was a problem hiding this comment.
@ponelat intended to write: Make a fork of Swagger-UI on GitHub, then clone your fork to your machine.
Will change for clarity, thx!
CONTRIBUTING.md
Outdated
| - Do not end the subject line with a period. | ||
| - Use the imperative mood in your subject lines, as if you were giving the code an order in your subject line. | ||
| - This mimics what Git does for you automatically: "Merge develop", "Revert f570ffc", etc | ||
| - Simple trick... your subject line should complete this sentence: `If applied, this commit will [your subject line].` |
There was a problem hiding this comment.
This is an awesome tip.
Would it make sense to use your tip, plus maybe two other points? I think the guide may be larger than needed, IMO.
|
Would this file make more sense to be located in |
|
@EWhite613, looks like that's how it was originally done (see https://github.com/github/github-services/blob/master/.github/CONTRIBUTING.md for an example). I recall that being the case in the not too distant past. I'm going off of https://help.github.com/articles/setting-guidelines-for-repository-contributors/, which states:
|
5 participants
Fixes #3014.
Here's my proposal for a Contributing Guidelines document.