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

To fix nbformat pre-commit instructions... #2234

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented Jun 13, 2023

The current instructions did not work from me and didn't seem to match the usage in the pre-commit docs. I believe that these changes will address the issue by

  1. specifying that the given YAML contents go in a .pre-commit-config.yaml file;
  2. clarifying that .pre-commit-hooks.yaml is a pre-commit plugin;
  3. fixing the rev (there's no pre-commit rev so I used the only release tag I found); and
  4. completing the config by specifying which hooks to run (from the plugin).

However, it still won't work as-is because .pre-commit-hooks.yaml is not located at the root of the repo (as indicated in https://pre-commit.com/#new-hooks). Am I missing something? E.g. is tools/tensorflow_docs/tools intended as some sort of subrepo?

The current instructions did not work from me and didn't seem to match the usage in the [pre-commit docs](https://pre-commit.com/).

I believe that these changes (almost) address the issue by

a) specifying that the YAML contents go in a `.pre-commit-config.yaml` file`;
b) clarifying that `.pre-commit-hooks.yaml` is a pre-commit plugin; and
c) completing the config YAML by specifying which `hooks` to run (from the plugin)

However, this still won't work because `.pre-commit-hooks.yaml` is not located at the root of the repo (as required in https://pre-commit.com/#new-hooks). Am I missing something? E.g. is tools/tensorflow_docs/tools intended as some sort of sub-repo?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant