Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 2.32 KB

Contributing to Omics-Dashboard

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the GNU Affero General Public License

In short, when you submit code changes, your submissions are understood to be under the same AGPL v3 that covers the project. Feel free to contact the maintainers if that's a concern. See the "License" section of README.md for more information.

Code Style

All python code submitted to the project should follow PEP-8.

Report bugs and feature requests using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue. Good issues should follow the templates provided.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

References

This document was adapted from @briandk's example CONTRIBUTING.md, which was in turn adapted from the open-source contribution guidelines for Facebook's Draft