Skip to content

Commit

Permalink
docs: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
George Adams committed Jan 16, 2017
1 parent 36362fe commit 568f7bb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Making changes to CitGM
#### There are a few basic requirements for making changes to CitGM

* Create an issue prior to submitting PR's as this can help speed up the process
* Include tests for your code wherever possible
* Include any documentation or manual changes where necessary
* Ensure that `npm test` passes before submitting the PR
* Please squash each logical change into one single commit
* Follow the nodejs commit guidelines shown [here](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit)

## Flaky and Skip Changes to lookup.json
The process for adding flaky or skip tags to the lookup.json is reasonably simple. Make your changes put together a PR with ideally a link to the community CI failing and then it will be reviewed.


## Submitting a module to CitGM
[Read the module requirements](README.md#requirements-for-inclusion-in-nodejs-citgm-runs)

0 comments on commit 568f7bb

Please sign in to comment.