Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 2.15 KB
Raw

Contributing to PyTSMod

Thank you for contributing PyTSMod! 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 main.
  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 GPL-3.0 License

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

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!

Follow PEP8 Style Guide

To maintain the readability of codes, you should follow the PEP8 style guide. You can check your code whether it follows the PEP8 style guide with:

$ pip install pep8
$ pep8 path/code_to_check.py

Follow numpydoc for Docstring

We follow the numpydoc docstring guide.

License

By contributing, you agree that your contributions will be licensed under its GPL-3.0 License.

References

This document was adapted from the open-source contribution guidelines for Brian A. Danielak