pre-commit / pre-commit/pre-commit.com

Add links to example `.pre-commit-config.yaml`s

Open
#29 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
208
Forks
307
Avg merge
20h 3m
Merged PRs (30d)
4

Description

The documentation could use with more links to some examples. (Adding issue on behalf of @ivanlei)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names example .pre-commit-config.yaml files but does not identify a documentation file or section. Locate the relevant documentation page and existing example links first; done means adding useful links to example configurations and verifying they render correctly.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.