Thanks for considering to contribute. We're open for any improvements.
Use one of our issue templates to either submit a bug or request a feature.
To submit a minor change (bugfix), just create a pull request with a clear and concise description of what you're trying to address.
To submit a major change (feature, refactoring), link it with an open issue; consider creating one if needed.
We appreciate clean and elegant code, and we love to follow some conventions in our journey.
- Use docstrings for each new class or function.
- Use Google Style docstrings.
- Avoid creating utils or helper modules, classes or functions.
- Avoid using
getin method names. For example,get_itemshould beitem.
Consider checking the source code for a more detailed picture.
- Use clear and concise commit messages.
- Start a commit message with a verb in the past tense, then describe the meaning of change, end with a period. For example,
Added something.,Cleaned up something.,Removed something.,Renamed `x` to `y`..
Note that we don't use the imperative style for messages.
Consider checking the commit history for a more detailed picture.