Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAMathews committed Mar 20, 2016
1 parent fb28ed0 commit 0f01a81
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Filing an issue

If you want your issue to be resolved quickly, please include in your
issue:

* Gatsby version, node.js version, OS version
* The contents of your `gatsby.config.js` and `package.json`.

# Contributing
You can install the latest `master` version of Gatsby by following these
simple steps:

* Clone the repo, navigate to its directory.
* Execute `npm install` to install packages.
* Execute `npm uninstall -g gatsby && npm link`
* Use `git pull` to update to latest Gatsby.

Test suite can be run via `npm test`.

The usual contributing steps are:

* Fork the [official repository](https://github.com/gatsbyjs/gatsby).
* Clone your fork: git clone `git@github.com:<your-username>/gatsby.git`
* Make sure tests are passing for you: npm install && npm test
* Create a topic branch: git checkout -b topics/new-feature-name
* Run `npm run watch` to watch code and compile your changes.
* Add tests and code for your changes.
* Once you‘re done, make sure all tests still pass: npm install && npm test
* Commit and push to your fork.
* Create an pull request from your branch.

0 comments on commit 0f01a81

Please sign in to comment.