浏览代码

Add contributing guidelines and fix small typos

Sam Julien 9 年之前
父节点
当前提交
e188c2c895
共有 3 个文件被更改,包括 32 次插入9 次删除
  1. 28 0
      CONTRIBUTING.md
  2. 3 8
      README.md
  3. 1 1
      front-end/js/app.js

+ 28 - 0
CONTRIBUTING.md

@@ -0,0 +1,28 @@
+## Developing
+
+### Setup
+
+First, set up your development environment using the same instructions on the [Readme](https://github.com/thingssdk/flasher.js/blob/master/README.md).
+
+### Testing
+
+Flasher.js uses mocha for running tests. You can run them with:
+
+```
+npm test
+```
+
+## Submitting Pull Requests
+
+**Please follow these basic steps to simplify pull request reviews.**
+
+* Please be sure your fork has the latest pull from master
+* Run ```npm install``` to make sure your development dependencies are up-to-date
+* Please ensure the test suite passes before submitting a PR
+* If you've added new functionality, *please include tests* which validate its behaviour
+* Make reference to possible [issues](https://github.com/thingssdk/flasher.js/issues) on your PR comment
+
+## Submitting bug reports
+
+* Please detail the affected board (e.g. Adafruit Huzzah Feather), firmware/binary name and version, and operating system(s)
+* Please be sure to state which version of node **and** npm you're using

+ 3 - 8
README.md

@@ -80,14 +80,9 @@ We are using [Bunyan](https://github.com/trentm/node-bunyan) for logging, make s
 
 ## Contributing
 
-If you want to contribute to the Flasher.js clone this repo and
- run the following commands.
-
-```bash
-npm install
-npm start
+We would love your contributions! Check out the [contribution guidelines](https://github.com/thingssdk/flasher.js/blob/master/CONTRIBUTING.md).
 ```
 
-## Licence 
+## License 
 
-Flasher.js is released under the [MIT Licence](https://opensource.org/licenses/MIT)
+Flasher.js is released under the [MIT License](https://opensource.org/licenses/MIT)

+ 1 - 1
front-end/js/app.js

@@ -155,7 +155,7 @@ function getManifests() {
             .then(processJSON)
             .then(generateManifestList).catch(error => {
                 setTimeout(getManifests, CONSTANTS.pollTime);
-            });S
+            });
     });
 }