Create a hook for validating file name
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation, tooling
Research direction
No implementation files, tests, or entry points are named. Review the existing hooks in ansys/pre-commit-hooks first, then clarify the target documentation paths, exact lowercase-and-hyphen convention, configuration needs, and validation coverage; done means noncompliant documentation filenames are reliably detected.
Written by the indexing model from the issue text.
Description
💡 Idea
When it comes to documentation, the usage of lowercase and hyphens in files names is important. This is because the name of the files set the final slug in the URL of the docs.
It is likely that a developer uses snake case or camel case when creating a source code file. However, these naming conventions should be avoided for files that render into docs.
Thus, I am proposing the creation of a hook that ensures a file is compliant with a certain naming convention.
- Dominant language
- Python
- Stars
- 5
- Forks
- 1
- Avg merge
- 1h 47m
- Merged PRs (30d)
- 7
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ansys/pre-commit-hooks
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
ansys/pre-commit-hooks#115 · 1 comment ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 55/100
ansys/pre-commit-hooks#411 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
ansys/pre-commit-hooks#389 · 2 reactions ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ansys/pre-commit-hooks#282 · 1 comment · 2 reactions ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
ansys/pre-commit-hooks#277 · 1 reaction ·
All issues in ansys/pre-commit-hooks
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100