mashafrancis/butternut-user

View on GitHub
.github/CONTRIBUTING.md

Summary

Maintainability
Test Coverage
## Support or Contribution

For any suggestions or contributions please do not hesistate to contact the owners of this repository.
Contributions to this project are welcomed by all, If you need to contribute, follow the steps below:

- **Fork** the repository
- Follow Installation and Setup as explained earlier
- Create a branch off `develop` for the feature you wish to add
- Make necessary changes, commit and raise a pull request against develop, conventions can be found on the [wiki page](https://github.com/mashafrancis/almond-hw/wiki).
- Note when making contributions, please endeavour to follow the [Airbnb javascript style guide](https://github.com/airbnb/javascript). Also make sure to follow the [Butternut Guide](https://github.com/mashafrancis/almond-hw/wiki) for conventions. We also leverage the following:
    - TSLint rules: **tslint-eslint-rules**, **tslint-config-airbnb**
    - Style rules: **stylelint**
- Once you try to create a commit, we have pre-commit hooks that would run against your code to point out things you are to fix if applicable.