Skip to content

Latest commit

 

History

History
29 lines (15 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

29 lines (15 loc) · 1.91 KB

Contributing

First off, thanks for considering contributing to impactasaurus. The project will not succeed without volunteers like yourself!

The following is a set of guidelines for contributing to Impactasaurus. Use your best judgment, and feel free to propose changes to this document in a pull request.

By participating in this project, you agree to abide by the code of conduct.

Communication

Most communication should occur via github issues, this allows people from different timezones to contribute. For short, live discussions, there is a gitter chat room available.

Reporting Bugs

Please raise an issue in github with the bug label. Please provide as much detail as possible, ideally with steps to reproduce.

Suggestions Improvements

Please raise an issue in github with an enchancement or new feature label. This will normally result in a discussion of the proposed feature and, if suitable, discussion about how it could be achieved.

Code Contributions

Please fork the project, make the changes, testing where possible, then raise a pull request. If you are unfamiliar with this process this gist is a good starting point.

To get started contributing code, please look at issues tagged with good first issue or help wanted tags. Typically good first issue issues with be minor changes requiring a line or two of code change. help wanted issues will be a bit more involved than good first issue issues.

If you are making a substantial change to the code, please discuss it with the project owners first to ensure you are spending your time wisely. See the communication section for details of how to get in touch.

We hope to get to your pull request as quickly as possible, however, sometimes this is not possible, so please bear with us :)