The CI folder contains formatting, linting, and test scripts, but the documentation needs to clearly explain how contributors should use them.
Tasks
- Update docs/ci_guide.md with step-by-step explanations
- Explain what format.sh, lint.sh, and run_tests.sh do
- Add instructions to run CI checks locally
- Add a diagram showing the CI workflow
- Link CI checks to .github/workflows/main-ci.yml
Goal
Help contributors understand the CI process so they can test their work before creating pull requests.
The CI folder contains formatting, linting, and test scripts, but the documentation needs to clearly explain how contributors should use them.
Tasks
Goal
Help contributors understand the CI process so they can test their work before creating pull requests.