geoff
/
testit
mirror of https://github.com/n2geoff/testit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

contrib fixes

This commit is contained in:
Geoff Doty 2018-12-02 03:40:30 -05:00
parent 6c437a619e
commit e72a99fec1
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Contributing # Contributing
So you want to contribute, nice. **Thank you**. So you want to contribute, awesome. **Thank you**.
Bug reports and code and documentation patches are all welcome. You can help this project also by using the development version and by reporting any bugs you might encounter. Bug reports and code and documentation patches are all welcome. You can help this project also by using the development version and by reporting any bugs you might encounter.
@ -38,7 +38,7 @@ npm test
## Reporting a bug ## Reporting a bug
Use the [GitHub issue tracker](https://github.com/n2geoff/js-lib/issues) to report any bug you find. Use the [GitHub issue tracker](https://github.com/n2geoff/testit/issues/new) to report any bug you find.
Bugs description should include: Bugs description should include:
* How to reproduce the bug; * How to reproduce the bug;
@ -48,11 +48,9 @@ Would be nice to have some code showing how to reproduce the code, you may use [
## Request a feature ## Request a feature
Use the [GitHub issue tracker](https://github.com/n2geoff/js-lib/issues) to request a new feature. Use the [GitHub issue tracker](https://github.com/n2geoff/testit/issues/new) to request a new feature.
Keep in mind, this is a pure javascript library Keep in mind, this is a pure javascript library, no dependencies as minimal as possible
Feel free to port it to your favorite framework, such as [RiotJS](http://riotjs.com), Angular or VueJs in a new repository.
## Commit message ## Commit message
@ -60,11 +58,11 @@ Commit messages should includes GitHub number reference and a imperative easy to
## Coding style ## Coding style
If it is supported in all major browers without transpiling, then please use those JavaScript language features in your code, with one caveat -- readablity is king. If it is supported in all major browers without transpiling, then please use those JavaScript language features in your code, with one caveat -- readablity is king.
Currently all ES5 and ES6/ES2015 are available. Currently all ES5 and ES6/ES2015 are available.
This project is linted agaist [JSHint](https://github.com/jshint/jshint) and the [`.jshintrc`](.jshintrc) is dead-simple, and all you need to followed. This project is linted agaist [JSHint](https://github.com/jshint/jshint) and the [`.jshintrc`](.jshintrc) is dead-simple, and all you need to followed.
Thank you for reading this. Thank you for reading this.