Skip to content

install: add pre-commit config#1059

Merged
shcheklein merged 1 commit into
masterfrom
pre-commit
Mar 16, 2020
Merged

install: add pre-commit config#1059
shcheklein merged 1 commit into
masterfrom
pre-commit

Conversation

@efiop
Copy link
Copy Markdown
Contributor

@efiop efiop commented Mar 16, 2020

Related to treeverse/dvc#3406

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please chose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

@shcheklein shcheklein temporarily deployed to dvc-landing-pre-commit-0v1gtqu March 16, 2020 20:58 Inactive
@shcheklein shcheklein temporarily deployed to dvc-landing-pre-commit-0v1gtqu March 16, 2020 20:59 Inactive
@shcheklein shcheklein merged commit 52ab37d into master Mar 16, 2020
@efiop efiop deleted the pre-commit branch March 16, 2020 21:15
Copy link
Copy Markdown
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

Thanks for this PR! I'll address these small revisions:

To disable them, you need to **remove** or **edit** those files (i.e.
`rm .git/hooks/post-checkout`, `vim .git/hooks/pre-commit`).

## Using Pre-Commit tool
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Using Pre-Commit tool
## Using the **pre-commit** tool

No need for upper case here, I think. Maybe just bold

Comment on lines +80 to +81
DVC provides support for [pre-commit](https://pre-commit.com/) users. To adjust
`.pre-commit-config.yaml` you could either use
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
DVC provides support for [pre-commit](https://pre-commit.com/) users. To adjust
`.pre-commit-config.yaml` you could either use
DVC provides support to manage Git hooks with [pre-commit](https://pre-commit.com/).
To adjust `.pre-commit-config.yaml` you can either use

Comment on lines +106 to +108
- `--use-pre-commit-tool` - install pre-commit/pre-push/post-checkout hooks
into the [pre-commit](https://pre-commit.com/) config
(`.pre-commit-config.yaml`).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- `--use-pre-commit-tool` - install pre-commit/pre-push/post-checkout hooks
into the [pre-commit](https://pre-commit.com/) config
(`.pre-commit-config.yaml`).
- `--use-pre-commit-tool` - installs pre-commit, pre-push, post-checkout Git
hooks into the [pre-commit](https://pre-commit.com/) config file
(`.pre-commit-config.yaml`).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants