This repository has been archived by the owner on Oct 29, 2020. It is now read-only.

Contributing to mgcpy

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

We develop with GitHub

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

Use a consistent coding style

We use pep8 style guide. To setup,

pip install pycodestyle
Run ./install_hooks.sh to install the pre-commit hooks for enforcing pep8 before committing any code.

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!

Write bug reports with detail, background, and sample code
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
  - Be specific!
  - Give sample code
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work, screenshots, etc.)

Proposing new features / fixes

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

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

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0