You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update CONTRIBUTING.md
Signed-off-by: Tania Charchian <tatiana.charchian@productscience.ai>
* Encourage use of AI reviewer for PR submissions
Emphasize the importance of using the AI reviewer tool before PRs.
Signed-off-by: Tania Charchian <tatiana.charchian@productscience.ai>
---------
Signed-off-by: Tania Charchian <tatiana.charchian@productscience.ai>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -174,6 +174,7 @@ Once a Proposal has enough clarity and support, break it into scoped Issues with
174
174
- How do you know this PR fixes the problem?
175
175
- Which components are affected?
176
176
- Explain how this PR was tested and attach evidence.
177
+
- Optional: note if you ran [ai-reviewer](https://github.com/gonka-ai/ai-reviewer) and attach non-sensitive highlights from the summary.
177
178
- Tag relevant reviewers using @username.
178
179
- PRs without a meaningful description will not be reviewed. The description is part of the contribution.
179
180
- Review:
@@ -184,6 +185,23 @@ Once a Proposal has enough clarity and support, break it into scoped Issues with
184
185
- PRs (involving protocol logic or architecture) must go through a governance voting process (described below). Voting follows a simple majority unless otherwise stated.
Before opening or updating a PR, contributors are strongly encouraged to use [gonka-ai/ai-reviewer](https://github.com/gonka-ai/ai-reviewer), a single-binary CLI for structured, repo-aware review. It runs multiple specialized review personas, such as security, correctness, architecture, and project-specific lenses, and supports primers for project context and waivers for explicit policy. It is intended to complement human review, not replace it, especially as the volume of change grows.
191
+
It is also recommended to review the full presentation before using the tool in practice.
192
+
193
+
-[Full presentation recording on Discord](https://discord.com/channels/1336477374442770503/1415622117629624362/1485979219711234058)
- Helps surface cross-cutting risks early, including consensus, API, and operational edge cases, by using focused review prompts rather than one generic review pass.
199
+
- Review rules and project context can live in the repository, for example, under `.ai-review/<owner>/<repo>/` or in committed files with `ai_review` frontmatter, so feedback can stay aligned with how Gonka evolves in practice.
200
+
- Each run writes auditable artifacts, including reports, findings, and token or cost statistics, under `.ai-review/.../runs/...`, making results inspectable and easier to debug.
201
+
-`--dry-run` shows which personas and primers would run without calling model APIs, which is useful for validating configuration without incurring costs.
202
+
203
+
**Disclaimer:** AI output can be wrong or incomplete; maintainers retain final judgment on all merges. Do not paste secrets into prompts or reports.
204
+
187
205
## From Issue to PR to reward proposal (public lifecycle)
188
206
This project aims for an auditable flow from work request to delivery to governance recognition (when applicable).
0 commit comments