Conversation
There was a problem hiding this comment.
Pull request overview
Adds initial project/contribution documentation for the CACAO++/MILK effort and introduces/updates GitHub Actions workflows intended to enforce pre-commit checks and run CI.
Changes:
- Add draft project and contributor-facing documentation pages (overview, contributing, git, coding, AI usage).
- Add a pre-commit GitHub Actions workflow that can auto-commit formatting fixes back to PR branches.
- Add a new CI workflow intended to build and run a basic smoke test.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 18 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/project/project_overview.md | Draft high-level project overview scaffold (timeline, WPs, KPIs). |
| doc/project/git_guidelines.md | Branching/commit/PR process and local pre-commit setup guidance. |
| doc/project/contributing.md | Contribution policy overview and role expectations. |
| doc/project/code_guidelines.md | Coding/documentation conventions and automation expectations. |
| doc/project/ai_guidelines.md | Principles and constraints for AI-assisted contributions. |
| .github/workflows/pre-commit.yaml | Workflow to run pre-commit and optionally push auto-fixes back to PR branches. |
| .github/workflows/ci.yml | New CI workflow intended to compile and run a simple command. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+70
to
+83
| - name: Commit if changes | ||
| # always() bypasses the error code from pre-commit. | ||
| # don't run again if this review has been triggered by github-actions[bot], | ||
| # since this would create an action loop. | ||
| if: github.event_name == 'pull_request' && github.actor != 'github-actions[bot]' | ||
| # Normally github message would include [skip ci] to prevent loops, but since this is the pre-commit fixer, it should be stable. | ||
| run: | | ||
| git config user.name "github-actions[bot]" | ||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
| git add -A | ||
| if ! git diff --cached --quiet; then | ||
| git commit -m "chore: auto-format code [skip ci]" | ||
| git push | ||
| fi |
There was a problem hiding this comment.
This step attempts to commit and git push changes back to the PR branch. For PRs from forks, the workflow token typically cannot push to the contributor’s fork, causing the job to fail and block the PR. Consider skipping this step when github.event.pull_request.head.repo.fork == true (or when head.repo.full_name != github.repository).
oguyon
reviewed
Apr 7, 2026
|
|
||
| If using AI, see `ai_guidelines.md` on prompt requirements. | ||
|
|
||
| Increment the version number just prior to merge (FIXME: maybe we can make an action for that), make sure the submodules have the right references. |
Member
There was a problem hiding this comment.
We need some convention here. When are we updating the version? When pushing dev to main? minor, major version numbers?
Member
Author
|
@jaredmales @oguyon I pushed the draft licensing plan in 3b66860 |
typos Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update doc/project/contributing.md typos Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update doc/project/code_guidelines.md typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update doc/project/contributing.md typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update doc/project/code_guidelines.md full path Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update doc/project/git_guidelines.md typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update doc/project/project_overview.md typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update doc/project/git_guidelines.md typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Clarified guidelines for including AI prompts in pull requests: what to include.
oguyon
force-pushed
the
vd/project_doc_draft
branch
from
3b66860 to
7b7aa89
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.