docs(README.md): update poetry dev dependency usage #619
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since Poetry 1.2.0 dependency groups are introduced, and `--dev` becomes deprecated, and instead `--with dev` has to be provided.
Lee-W
reviewed
Nov 17, 2022
|
|
||
| ```bash | ||
| poetry add commitizen --dev | ||
| poetry add commitizen --group dev |
There was a problem hiding this comment.
Instead of just use --group, I might suggest add poetry version as well. e.g.,
# for poetry >= 1.2.0
...
# for poetry < 1.2.0
Lee-W
approved these changes
Nov 17, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since Poetry 1.2.0 dependency groups are introduced, and
--devbecomes deprecated, and instead--with devhas to be provided. This PR updates the documentation to reflect this change.Description
Change the documentation in order to reflect the updated way for dependency groups.
Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testExpected behavior
The documentation can be followed as it is, instead of getting warnings/ errors.
Steps to Test This Pull Request
Additional context