Contributing

Thank you for your interest in contributing to Opfi. Contribututions can take many forms, including:

  • Reporting a bug

  • Discussing the current state of the code

  • Submitting a fix

  • Proposing new features

Issues

Issues should be used to report problems or bugs with the library, to request new features, or to discuss potential changes before PRs are created.

Good bug reports have:

  • A summary of the issue

  • Specific steps to reproduce the problem, preferably in the form of code examples

  • A description of expected behavior

  • A description of actual behavior

Pull Requests

In general, we use Github Flow. This means that all changes happen through Pull Requests:

  1. Fork the repository to your own Github account

  2. Clone the project to your machine

  3. Create a branch locally with a succinct but descriptive name

  4. Commit changes to the branch

  5. Push changes to your fork

  6. Open a PR in our repository and include a description of the changes and a reference to the issue the PR addresses

Coding Style

Contributors should attempt to adhere to the PEP8 style guide when possible, although this is not currently strictly enforced. At a minimum, new contributions should follow a style that is consistent with the preexisting code base.

Testing

We use the pytest framework for creating unit tests. Please write tests for any new code contributed to this project.

License

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

Code of Conduct

We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.

Attribution

This document was adapted from the General Contributing Guidelines of the rextendr project, and from the contributing template developed by briandk.