Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JesperLekland committed Mar 7, 2018
1 parent e1d65c4 commit b2ab22c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,12 @@
# Contributing to react-native-svg-charts

First of all a __big__ thank you for wanting to contribute to this library. 馃弳

In order for this to be maintainable we ask you to follow these rules when contributing.

* work off of and make your pull request to the `dev` branch. Master is meant to reflect what's published to npm, think git flow.
* make sure that you understand how this library works and utilize what's already in place, try not to introduce new complexity unless properly motivated.
* motivate why you've made the changes you have made in the PR description.
* make sure your implementation doesn't break anything, step through all the StoryBook stories and make sure everything look as expected. Also make sure that the circleci builds are passing.
* create one (or several) new story/stories that showcases your new feature
* fork [`react-native-svg-charts-examples`](https://github.com/JesperLekland/react-native-svg-charts-examples) and make a PR with your newly implementes stories (include screenshots).

0 comments on commit b2ab22c

Please sign in to comment.