ansys / ansys/pre-commit-hooks

Create a hook for validating file name

Open
#147 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
5
Forks
1
Avg merge
4h 21m
Merged PRs (30d)
9

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.