Contributing to Pandagg¶

We want to make contributing to this project as easy and transparent as possible.

Our Development Process¶

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

Pull Requests¶

We actively welcome your pull requests.

Fork the repo and create your branch from master.
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.

Any contributions you make will be under the MIT Software License¶

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that’s a concern.

Issues¶

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

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 if you can.
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)

License¶

By contributing, you agree that your contributions will be licensed under its MIT License.

References¶

This document was adapted from the open-source contribution guidelines of briandk’s gist