Thank you for your interest in contributing to this project! Before contributing please read these guidelines, they'll outline the types of contributions we're looking for and how you should be contributing to this project. As this tool is designed to be used in enterprise environments, we will closely review and thoroughly test contributions to make sure they don't disrupt the operations of any organization leveraging this tool for their operations. Please understand that this, like all projects, is a work in progress.
Responsibilities
- Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
- Ensure that code that goes into core follows PEP8 standards
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions.
- Keep features as limited in scope as possible.
- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Python Community Code of Conduct.
We welcome Issues and PRs on this project. If the contribution you are proposing is trivial, feel free to simply open a PR, otherwise refer to the guidelines below. We currently do not require any CLA to begin contributing, but if you make a significant contribution be aware that we might reach out to you in the future if we ever try to relicense this project. All contributions must be fully documented and unittested. Contributers who introduce significant features or ench
We maintain a list of things we would like to add to this project or aspects of it we would like to fix or improve. If you just want to get involved and not sure where to start, take a look at TODO.md for ideas. Picking one of those up would be amazing and much appreciated!
Open an Issue on the project and label it appropriately. Please understand that some things that you might consider bugs could be intended. Please provide sufficient material to justiy your belief that this bug exists (stack traces, examples of race conditions or abherrent behavior, etc.). When reporting a bug, try to make life as easy as possible for the maintainers. Once the bug is confirmed the reporter is responsible for opening up a PR to propose a fix. Allow up to two weeks for a maintainer to review your bug submission.
PLEASE NOTE: If you are reporting a security vulnerability DO NOT open an Issue, email security@octanelending.com immediately
Any features or enhancement must be opened as Issues on the project and labelled appropriately for full and transparent discussion between maintainers and contributors. It is up to the maintainers discretion as to what features are approved. The maintainers have the responsibility to make sure any contributions to this project are inline with the intended purpose. Maintainers will also close issues on a monthly basis if there is no activity.
All code must be reviewed and approved by one of the listed maintainers before any PR can be merged into the project. Please ensure any contributions are fully documented and unittested. Undocumented or untested contributions will be rejected. Maintainers will also be responsibile for decideding the versioning of any contribution you make. If suggestions are made by maintainers and not responded to within two weeks, your PR may be closed. Maintainers will also handle any merging and publishing of any new releases. Branches will be deleted once merged.
By contributing to this project you agree that your contributions will be licensed under its Apache 2.0 license.
- Josh Marcus-Hixson a.k.a. jixson12