neulab / ExplainaBoard

Interpretable Evaluation for AI Systems

MIT License

359 stars 36 forks source link

Lint Markdown files #536

Closed tetsuok closed 1 year ago

tetsuok commented 1 year ago

Currently, we manually check the syntax and style of Markdown files. The review process is time-consuming and can be inconsistent. It's better to automate the check so that reviewers can focus on the contents and clarity.

Actions

[x] Set up pre-commit and CI
[x] Fix all the remaining issues

pfliu-nlp commented 1 year ago

Hi, @tetsuok A lot of new errors appeared regarding markdown lint when making a new PR, for example https://github.com/neulab/ExplainaBoard/actions/runs/3211437027/jobs/5249605967

tetsuok commented 1 year ago

@pfliu-nlp The linter found that the change doesn't follow the rules. It's not a bug in the linter. Found errors need to be fixed in the same way as we fix errors found by flake8. Would you fix them?

tetsuok commented 1 year ago

@pfliu-nlp Some trivial errors can be fixed automatically by running 'pre-commit run markdownlint-cli2-fix --all-files'.

neubig commented 1 year ago

@tetsuok : I think the issue was probably that the PR that @pfliu-nlp was working on had not yet merged in the main branch. I just did it now, so let's see if that fixes the problem.

Update: NVM, the original comment was correct actually. Running that command fixed most of the linting errors but there was still one that needed to be fixed manually.

tetsuok commented 1 year ago

@neubig Ok. Thanks for the update.