Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.6 KB

CONTRIBUTE.md

File metadata and controls

59 lines (38 loc) · 2.6 KB
Raw

Contributing to FinPack

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

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

Please note we have a code of conduct, please follow it in all your interactions with the project.

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. Open an issue to discuss with code owners before making a change.
  2. Fork the repo and create your branch from master.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code lints (isort and black).
  7. Issue that pull request!

Any contributions you make will be under the Apache 2.0 Software License

In short, when you submit code changes, your submissions are understood to be under the same Apache License 2.0 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!

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; sample code that anyone with a base python 3.x setup can run to reproduce what I was seeing.
  • 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)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

  • We have setup a pre-commit-config.yaml containing all the checks, here is the command: poetry run pre-commit

License

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