Merge pull request #55 from darklordace/master

Add CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+We welcome community support with both pull requests and reporting bugs. Please
+don't hesitate to jump in.
+
+## Review others' work
+
+Check out the list of outstanding pull requests if there is something you might
+be interested in. Maybe somebody is trying to fix that stupid bug that bothers
+you. Review the PR. Do you have any better ideas how to fix this problem? Let us
+know.
+
+## Issues
+
+The issue tracker is the preferred channel for bug reports, features requests
+and submitting pull requests, but please respect the following restrictions:
+
+- Please do not use the issue tracker for personal support requests.
+- Please do not open issues or pull requests regarding the code in React or
+Docusaurus (open them in their respective repositories).
+
+## Local setup
+
+To install jasper-ui:
+- npm install
+
+To install documentation page:
+- cd docusaurus && npm install
+
+To run storybook:
+- npm run storybook
+
+To run documentation page:
+- Run this in one terminal:
+  - npm start
+- Run this in another terminal:
+  - cd docusaurus && npm start
+
+## Testing
+
+To run all tests:
+- npm test
+
+To run test with coverage:
+- npm run test:coverage
+
+To run test and update snapshots:
+- npm run test:watch

README.md

@@ -35,35 +35,9 @@ class Example extends Component {
 }
 ```
 
-## Local setup
-
-To install jasper-ui:
-- npm install
-
-To install documentation page:
-- cd docusaurus && npm install
-
-To run storybook:
-- npm run storybook
-
-To run documentation page:
-- Run this in one terminal:
-  - npm start
-- Run this in another terminal:
-  - cd docusaurus && npm start
-
-
-## Testing
-
-To run all tests:
-- npm test
-
-To run test with coverage:
-- npm run test:coverage
-
-To run test and update snapshots:
-- npm run test:watch
+## Contributing
 
+> #### [Please follow these steps to contribute](CONTRIBUTING.md).
 
 ## License