Thank you for considering improving Loguru, any contribution is much welcome!
If you have any question about Loguru, if you are seeking for help, or if you would like to suggest a new feature, you are encouraged to open a new issue so we can discuss it. Bringing new ideas and pointing out elements needing clarification allows to make this library always better!
Reporting a bug
If you encountered an unexpected behavior using Loguru, please open a new issue and describe the problem you have spotted. Be as specific as possible in the description of the trouble so we can easily analyse it and quickly fix it.
An ideal bug report includes:
The Python version you are using
The Loguru version you are using (you can find it with
Your operating system name and version (Linux, MacOS, Windows)
Your development environment and local setup (IDE, Terminal, project context, any relevant information that could be useful)
If you are willing to enhance Loguru by implementing non-trivial changes, please open a new issue first to keep a reference about why such modifications are made (and potentially avoid unneeded work).
Prefer using a relatively recent Python version as some dependencies required for development may have dropped support for oldest Python versions. Then, the workflow would look as follows:
Fork the Loguru project from GitHub.
Clone the repository locally:
$ git clone firstname.lastname@example.org:your_name_here/loguru.git $ cd loguru
Activate your virtual environment:
$ python -m venv env $ source env/bin/activate
Install Loguru in development mode:
$ pip install -e ".[dev]"
Install pre-commit hooks that will check your commits:
$ pre-commit install --install-hooks
Create a new branch from
$ git checkout master $ git branch fix_bug $ git checkout fix_bug
Implement the modifications wished. During the process of development, honor PEP 8 as much as possible.
Add unit tests (don’t hesitate to be exhaustive!) and ensure none are failing using:
$ tox -e tests
Remember to update documentation if required.
If your development modifies Loguru behavior, update the
CHANGELOG.rstfile with what you improved.
commityour changes, then
pushyour local project:
$ git add . $ git commit -m 'Add succinct explanation of what changed' $ git push origin fix_bug
If previous step failed due to the pre-commit hooks, fix reported errors and try again.
Finally, open a pull request before getting it merged!