Skip to content

add --dev flag to readme#70

Merged
MarkKoz merged 1 commit into
python-discord:masterfrom
nnsee:clarify-readme
Mar 29, 2020
Merged

add --dev flag to readme#70
MarkKoz merged 1 commit into
python-discord:masterfrom
nnsee:clarify-readme

Conversation

@nnsee
Copy link
Copy Markdown
Contributor

@nnsee nnsee commented Mar 29, 2020

In the "development environment" section of the readme, it instructs to run pipenv sync to install dependencies and pipenv run precommit immediately after to install the pre-commit hooks. Since the pre-commit package (and related packages) is listed in the pipfile under [dev-packages], this command fails.

Solution: instruct the user to install all dependencies with the --dev flag.

@nnsee nnsee requested a review from a team as a code owner March 29, 2020 11:33
Copy link
Copy Markdown
Contributor

@Akarys42 Akarys42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fair to me

@MarkKoz MarkKoz added area: docs Adds or updates documentation type: bug Something isn't working labels Mar 29, 2020
@MarkKoz MarkKoz merged commit 46faa97 into python-discord:master Mar 29, 2020
@MarkKoz
Copy link
Copy Markdown
Contributor

MarkKoz commented Mar 29, 2020

Thanks for catching that

@nnsee nnsee deleted the clarify-readme branch March 29, 2020 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Adds or updates documentation type: bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants