Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

--lint to check ADRs for content we need #52

Open
mrwilson opened this issue Sep 11, 2023 · 0 comments
Open

--lint to check ADRs for content we need #52

mrwilson opened this issue Sep 11, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mrwilson
Copy link
Owner

mrwilson commented Sep 11, 2023 •
edited
Loading

The project assumes some things about the structure of the ADRs based on adr-tools and common variations of the ADR format.

It'd be useful to have a separate linting capability so users can test these things. Things like:

$ adr-viewer --lint --adr-path adrs/

✅ 0001-adr-one.md
❌ 0002-adr-two.md - Missing useful fields: status
❌ 0003-adr-three.exe.md - Unable to parse file as markdown in ADR format
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mrwilson