adds CONTRIBUTING.md file

zzkk · Oct 10, 2014 · 95ffe76 · 95ffe76
1 parent 7a09952
commit 95ffe76
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 31 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1 +1,2 @@
 test
+CONTRIBUTING.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+## Contributing
+
+Thanks for taking the time to help make harp better. Here are some guidlines that will highly increase the chances of your fix or feature request from being accepted.
+
+### Bug Fixes
+
+If you find a bug you would like fixed. Open up a [ticket](https://github.com/sintaxi/harp/issues/new) with a detailed description of the bug and the expected behaviour. If you would like to fix the problem yourself please do the following steps.
+
+1. Fork it.
+2. Create a branch (`git checkout -b fix-for-that-thing`)
+3. Commit a failing test (`git commit -am "adds a failing test to demonstrate that thing"`)
+3. Commit a fix that makes the test pass (`git commit -am "fixes that thing"`)
+4. Push to the branch (`git push origin fix-for-that-thing`)
+5. Open a [Pull Request](https://github.com/sintaxi/harp/pulls)
+
+Please keep your branch up to date by rebasing upstream changes from master.
+
+### New Functionality
+
+If you wish to add new functionality to harp, please provide [@sintaxi](mailto:[email protected]) a harp application that demonstrates deficiency in current design or desired additional behaviour. You may also submit a pull request with the steps above.
+
+## License
+
+Copyright © 2012–2014 [Chloi Inc](http://chloi.io). All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ Pre-compilers are becoming extremely powerful and shipping front-ends as static
 
 ### Supported Pre-Processors
 
-|                 | Language Superset                                                 | Whitespace Sensitive  
+|                 | Language Superset                                                 | Whitespace Sensitive
 | --------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------
 | **HTML**        | [EJS](http://embeddedjs.com/)                                     | [Jade](http://jade-lang.com/), [Markdown](http://daringfireball.net/projects/markdown/)
 | **CSS**         | [LESS](http://lesscss.org/), [Sass (SCSS)](http://sass-lang.com/) | [Stylus](http://learnboost.github.io/stylus/), [Sass](http://sass-lang.com/)
@@ -123,33 +123,3 @@ app.configure(function(){
 });
 ```
 
-## Contributing
-
-### Bug Fixes
-
-If you find a bug you would like fixed. Open up a [ticket](https://github.com/sintaxi/harp/issues/new) with a detailed description of the bug and the expected behaviour. If you would like to fix the problem yourself please do the following steps.
-
-1. Fork it.
-2. Create a branch (`git checkout -b fix-for-that-thing`)
-3. Commit a failing test (`git commit -am "adds a failing test to demonstrate that thing"`)
-3. Commit a fix that makes the test pass (`git commit -am "fixes that thing"`)
-4. Push to the branch (`git push origin fix-for-that-thing`)
-5. Open a [Pull Request](https://github.com/sintaxi/harp/pulls)
-
-Please keep your branch up to date by rebasing upstream changes from master.
-
-### New Functionality
-
-If you wish to add new functionality to harp, please provide [@sintaxi](mailto:[email protected]) a harp application that demonstrates deficiency in current design or desired additional behaviour. You may also submit a pull request with the steps above.
-
-## License
-
-Copyright © 2012–2014 [Chloi Inc](http://chloi.io). All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/a0e15683fd92ec96089118f483a112cf "githalytics.com")](http://githalytics.com/sintaxi/harp)