sverweij/mscgen_js

View on GitHub
.github/CONTRIBUTING.md

Summary

Maintainability
Test Coverage
## Contributing

So you want to contribute to mscgen_js? We already love you! :heart:

To make this as easy as possible for you, here's some simple guidelines:

### General
- mscgen_js is released with a [code of conduct](../CODE_OF_CONDUCT.md), adapted
  from the [contributor covenant](http://contributor-covenant.org/).

### Reporting issues
- All **issues** are **welcome**.    
  - These include bug reports, questions, feature requests and enhancement
    proposals
  - [GitHub's issue tracker](https://github.com/sverweij/mscgen_js/issues)
    is the easiest way to submit them.
- GitHub will present you with an issue template - try to fill it out to
  the best of your abilities - it'll save a lot of time
- In turn, I try to **respond within a week**.    
  This might or might not include an actual code fix.

### Contributing code
- We prefer well documented
  **[pull requests](https://help.github.com/articles/creating-a-pull-request/)**
  based on the most recent version of the **master** branch.
- We have a 
- Code quality
    - Additions pass eslint as configured for this repo
    - Mocha tests prove your code does what it intends.
    - Your code does not introduce regressions - ```make check``` proves this.
    - Code style (you know, petty things like indentations, where brackets go,
      how variables & parameters are named) fits in with the current code base.
- Plan to do something drastic? leave an
  [issue](https://github.com/sverweij/mscgen_js/issues/new) first.


### Templates
GitHub will automatically present you with these at the right time, but if you
want to peruse:
- [ISSUE_TEMPLATE.md](ISSUE_TEMPLATE.md)
- [PULL_REQUEST_TEMPLATE](PULL_REQUEST_TEMPLATE)