Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 2.19 KB
Raw

Contributing to panoptes

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to panoptes. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

  • Report bugs
  • Propose or implement features
  • Submit code changes / fixes
  • Discuss code

See here for a short tutorial for GitHub's issue tracking system.

Please adhere to the Code of Conduct.

Reporting bugs

Please use the project's issue tracker to report bugs. If you have no experience in filing bug reports, see e.g., these recommendations by the Mozilla Developer Network first. Briefly, it is important that bug reports contain enough detail, background and, if applicable, minimal reproducible sample code. Tell us what you expect to happen, and what actually does happen.

Implementing features and submitting fixes

Kindly use pull requests to submit changes to the code base. But please note that this project is driven by a community that likes to act on consensus. So in your own best interest, before just firing off a pull request after a lot of work, please open an issue to discuss your proposed changes first. Afterwards, please stick to the following simple rules to make sure your pull request will indeed be merged:

  1. Fork the repo and create a feature branch from branch develop
  2. If you've added code that should be tested, add tests.
  3. Ensure that all tests pass.
  4. Document your code and update all relevant documentation.
  5. Stick to the code and documentation style (see below).
  6. Issue the pull request.

Don't forget to add your name and GitHub profile URL to the list of contributors.

Important: Note that all your contributions are understood to be covered by the same license that covers the entire project.