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.

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

Harmonise requirements towards markdown formatting #53

Open
ekatef opened this issue May 18, 2023 · 1 comment
Open

Harmonise requirements towards markdown formatting #53

ekatef opened this issue May 18, 2023 · 1 comment
Labels
good first issue Good for newcomers

Comments

@ekatef
Copy link
Member

ekatef commented May 18, 2023

Currently CI fails for every PR which introduces any changes into README. The reason in that requirements of github linter used do not quite match with README formatting. In particular, there are following points to be fixed:

  • line length is too big (100..250 vs 80 default);
  • an exclamation mark in a header.

Possible solution:

  1. Include markdown linter into pre-commit
  2. Change linter defaults
@davide-f davide-f added the good first issue Good for newcomers label May 18, 2023
@ekatef
Copy link
Member Author

ekatef commented May 19, 2023

A list of markdown linters can be extracted from a pre-commit list.

Defaults of Github Markdown linter are explained here.

An example of tackling a similar issue
IBM/ibmi-oss-docs#53

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants