Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 957 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 957 Bytes

Contributing Guide

Thanks for thinking about contributing to this package, it makes you awesome! I do ask you follow a couple of rules just to keep things neat and tidy. It is highly unlikely that your pull request will be accepted if you don't follow them, so please read carefully.

1. Unit Tests

This package is fully unit tested with 100% code coverage. Please ensure that any modifications you make are tested to the same degree.

2. Code Style

This package follows the PSR-2 coding standard. Please ensure your code does the same.

3. Documentation

Please ensure that you keep the docs/ up to date with any changes that you make!

4. Pull Requests Checklist

Please make sure that your pull request includes:

  • Reason for change
  • Any open Issues that this touches / resolves
  • Unit tests
  • Documentation changes

That's it! Happy coding!