Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document updating requirements with pre-commit hooks #1387

Conversation

microcat49
Copy link
Contributor

@microcat49 microcat49 commented Apr 17, 2021

Resolves #1335

Changelog-friendly one-liner:

This commit adds documentation about using pre-commit when a user has multiple requiments. A user need to have multiple hooks for each requirements file and this commit makes that informationn explicit in the documentation.

Contributor checklist
  • Provided the tests for the changes.
  • Gave a clear one-line description in the PR (that the maintainers can add to CHANGELOG.md on release).
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

This commit adds documentation about using pre-commit when a user has multiple requiments. A user need to have multiple hooks for each requirements file and this commit makes that informationn explicit in the documentation.
@codecov

This comment has been minimized.

README.rst Outdated Show resolved Hide resolved
@atugushev atugushev added docs Documentation related pre-commit Related to pre-commit hook labels Apr 18, 2021
@microcat49
Copy link
Contributor Author

Hey @atugushev, sorry about the delayed response on this one. This is ready for another review.

Co-authored-by: Albert Tugushev <albert@tugushev.ru>
@ssbarnea ssbarnea changed the title Maintenance/document how to check multiple requirements with pre commit hooks Document updating requirements with pre commit hooks Jun 5, 2021
README.rst Outdated Show resolved Hide resolved
@ssbarnea ssbarnea merged commit f953ceb into jazzband:master Jun 11, 2021
@atugushev atugushev changed the title Document updating requirements with pre commit hooks Document updating requirements with pre-commit hooks Jun 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related pre-commit Related to pre-commit hook
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to check multiple requirements with pre-commit hooks
4 participants