silentrob/superscript

View on GitHub
contribute.md

Summary

Maintainability
Test Coverage
# Contribute.md

## Request for contributions

Thanks for taking the time to help make SuperScript 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/silentrob/superscript/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/silentrob/superscript/pulls)

Please keep your branch up to date by rebasing upstream changes from master.

### New Functionality

If you wish to add new functionality to superscript, that is super cool, lets chat about what that feature is and how best it could be implemented. You can use [gitter](https://gitter.im/silentrob/superscript), [twitter](https://twitter.com/rob_ellis) email or Issues to engague on new features. Its best if you explaing the problem you are trying to solve, not just the solution you want. You may also submit a pull request with the steps above.