First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to Poetry on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
This section guides you through submitting a bug report for Poetry. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please check this list to be sure that you need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks helps the maintainers resolve the issue faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
Explain the problem and include additional details to help maintainers reproduce the problem:
Provide more context by answering these questions:
Include details about your configuration and environment:
poetry -Vin your terminal.
debug:infoto get the information.
This section guides you through submitting an enhancement suggestion for Poetry, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Enhancement suggestions are tracked on the official issue tracker where you can create a new one and provide the following information:
You will need Poetry to start contributing on the Poetry codebase. Refer to the documentation to start using Poetry.
You will first need to clone the repository using
git and place yourself in its directory:
$ git clone email@example.com:python-poetry/poetry.git $ cd poetry
Now, you will need to install the required dependency for Poetry and be sure that the current tests are passing on your machine:
$ poetry install $ poetry run pytest tests/
Poetry uses the black coding style and you must ensure that your code follows it. If not, the CI will fail and your Pull Request will not be merged.
Similarly, the import statements are sorted with isort and special care must be taken to respect it. If you don't, the CI will fail as well.
To make sure that you don't accidentally commit code that does not follow the coding style, you can install a pre-commit hook that will check that everything is in order:
$ poetry run pre-commit install
You can also run it anytime using:
$ poetry run pre-commit run --all-files
Your code must always be accompanied by corresponding tests, if tests are not present your code will not be merged.