Update the CONTRIBUTING.md file to add details regarding pre-commit & GitHub Actions local setup #254
Conversation
This file contains 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
…s setup Add details to `CONTRIBUTING.md` on auto-assigning issues, pre-commit installation, and GitHub Actions local setup using 'act'. * **Auto-assigning issues**: Add a section explaining auto-assigning issues on the comment 'take', referencing the configuration in `.github/workflows/assign-on-comment.yml`. * **Pre-commit installation and execution**: Add a section detailing pre-commit installation and execution, referencing the configuration in `.pre-commit-config.yaml`. * **GitHub Actions local setup using 'act'**: Add a section providing instructions for GitHub Actions local setup using 'act', referencing the configuration in `.github/workflows/ci.yml`. Include instructions for running specific jobs and handling MacBooks with M1 processors.
| To run pre-commit hooks manually, use: | ||
| ```shell | ||
| pre-commit run --all-files | ||
| ``` |
There was a problem hiding this comment.
pre-commit is already in the pyproject (in 1.0 branch), so we do not need pip here, but we can use poetry
There was a problem hiding this comment.
@SemyonSinchenko - thanks for pointing that out. I have updated the doco to use poetry instead of pip
According to the review comment, make the pip installs as poetry installs
SemyonSinchenko
approved these changes
Jul 16, 2024
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.
Proposed changes
This is regarding the issue #246
Add details to
CONTRIBUTING.mdon auto-assigning issues, pre-commit installation, and GitHub Actions local setup using 'act'..github/workflows/assign-on-comment.yml..pre-commit-config.yaml.Types of changes
Further comments
N/A