search

qir-alliance / qat

QIR compiler tools and optimization passes for targeting QIR to different hardware backends
https://qir-alliance.github.io/qat/
MIT License
26 stars 14 forks source link

QIR Alliance PR check workflow #41

Closed bettinaheim closed 2 years ago

bettinaheim commented 2 years ago

Workflow directly from the org template without modifications. The markdown linting rules are hence defined by the org.

bettinaheim commented 2 years ago

Formatting and spell checking on markdown files is a nice thing to have. We probably should also have a check for inappropriate words. This PR, is a good contribution in that direction

As a minor note, I would have preferred that

  1. These checks were integrated into the structure that does the checks for C++ and Python. It would have been nice to be able to do ./manage stylecheck locally to get the report of errors and ./manage stylecheck --fix-issues to automatically fix them.
  2. That it was more transparent which tools are performing the tasks and how they are configured.

However, that said, this is a good first step and we can consider integration at a later point.

If you have ideas for how to improve the workflow I am happy to hear them. This is a basic workflow that should facilitate common guidelines across all PRs. While using a template still required checking in a copy of the workflow, I think it is a decent step. We could even consider packing a proper GitHub action to simplify the checked in file further in the future.