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

Improve markdown files content validation #392

Open
3 tasks
yannbertrand opened this issue Oct 28, 2024 · 1 comment
Open
3 tasks

Improve markdown files content validation #392

yannbertrand opened this issue Oct 28, 2024 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@yannbertrand
Copy link
Owner

Switching from defaults.yml to markdown files removed the automatic content validation rules we had. (see yml schema and tests)

We could improve validation for contributors and help maintenance. Here are a few things I have in mind:

  • Improve contributing documentation
  • Create a markdown template file that contributors could copy
  • Validate content in CI
@yannbertrand yannbertrand added enhancement New feature or request help wanted Extra attention is needed labels Oct 28, 2024
@yannbertrand
Copy link
Owner Author

Some contribution tips can be found in #391

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 help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@yannbertrand