This issue documents the ideas we are having re: design of a better style guide checker.
Considerations:
- developing GitHub actions that modifies PRs has not been a straight forward process due to restrictions in the GitHub API (such as only reviewing the diff lines (for comments and suggestions) rather than a full review of the lecture. It might be best to organise entire style guide reviews of single lectures.
Designs:
- Build a
rule-based style guide reference to apply, perhaps adopting a structured document type such as a yaml file that provides AI the context, the rule, a reference, and an example?
Simpler checks work very well
For example, asking AI to do this task QuantEcon/lecture-python.myst#574 worked very well, however when providing a overall style-guide.md document -- I find in testing this works a lot less reliably.
This issue documents the ideas we are having re: design of a better style guide checker.
Considerations:
Designs:
rule-basedstyle guide reference to apply, perhaps adopting a structured document type such as a yaml file that provides AI the context, the rule, a reference, and an example?Simpler checks work very well
For example, asking AI to do this task QuantEcon/lecture-python.myst#574 worked very well, however when providing a overall style-guide.md document -- I find in testing this works a lot less reliably.