nhs-england-tools / repository-template

🛠️ 📚💡 This is a detailed and carefully made template for your GitHub projects. It's based on the wide knowledge and practical experience of the engineering community within NHS England. The template includes helpful suggestions, standards and practices - it's something you should consider using for all your repositories.
MIT License
31 stars 12 forks source link

Vale for prose checking #135

Closed regularfry closed 1 year ago

regularfry commented 1 year ago

Description

Vale is a tool for performing a certain set of style checks, which this PR introduces for markdown files only. Vale can scan code comments, but as an initial validation we should limit the scope.

WIP for the moment while I sort out github action integration.

Context

We want to be sure that our documentation is consistent and readable.

Type of changes

Checklist


Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

regularfry commented 1 year ago

I've double-checked that we pick up vale failures with a test PR here. That was successful, so I think we can say this is no longer WIP.