AlexsLemonade / AlexsLemonade/OpenScPCA-analysis

Additional docs for troubleshooting precommit

Open
#645 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
HTML
Stars
16
Forks
24
Avg merge
3d 5h
Merged PRs (30d)
4

Description

> I think I have encountered this before, and it had something to do with the pre-commit cache. First check that you have the latest version of the hook with `pre-commit autoupdate -c {your.local.precommit.yml}`, but if that does not work you may want to run `pre-commit clean` and see if that fixes things.

_Originally posted by @jashapiro in https://github.com/AlexsLemonade/OpenScPCA-analysis/issues/642#issuecomment-2245666747_

---

I'm opening this issue to track a potential "nice to have" doc (either in the precommit page or FAQ) about troubleshooting advanced usage of `pre-commit`. This approach worked for me, so it may help others if it turns out they encounter it! We can add these docs if we get multiple questions about it.

Contributor guide

Open the contributing guide

Research direction

Review the existing pre-commit documentation and FAQ to find the appropriate location for troubleshooting guidance. Document the reported cache-related approach using `pre-commit autoupdate -c {your.local.precommit.yml}` and `pre-commit clean`; done means the guidance is added in the chosen documentation location.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.