Skip to content

Commit 37f82fb

Browse files
Happypig375Happypig375
committed
docs: define review policy and ownership
1 parent 7733c20 commit 37f82fb

4 files changed

Lines changed: 70 additions & 4 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# CODEOWNERS requests review from verified write-access owners for core changes.
2+
# Repository rules determine whether an approval is enforced.
3+
4+
/CSharpMath/ @Happypig375 @charlesroddie @FoggyFinder
5+
/CSharpMath.Core.Tests/ @Happypig375 @charlesroddie @FoggyFinder
6+
/CSharpMath.Rendering/ @Happypig375 @charlesroddie @FoggyFinder
7+
/CSharpMath.Rendering.Tests/ @Happypig375 @charlesroddie @FoggyFinder
8+
/CSharpMath.Rendering.Tests.FSharp/ @Happypig375 @charlesroddie @FoggyFinder
9+
/CSharpMath.Rendering.Text.Tests/ @Happypig375 @charlesroddie @FoggyFinder
10+
/CSharpMath.SkiaSharp/ @Happypig375 @charlesroddie @FoggyFinder
11+
12+
# Cross-cutting solution, build, workflow, review, and security policy files.
13+
/CSharpMath.slnx @Happypig375 @charlesroddie @FoggyFinder
14+
/global.json @Happypig375 @charlesroddie @FoggyFinder
15+
/.editorconfig @Happypig375 @charlesroddie @FoggyFinder
16+
/NuGet.Config @Happypig375 @charlesroddie @FoggyFinder
17+
/.gitmodules @Happypig375 @charlesroddie @FoggyFinder
18+
/.gitattributes @Happypig375 @charlesroddie @FoggyFinder
19+
/Directory.Build.props @Happypig375 @charlesroddie @FoggyFinder
20+
/Directory.Build.targets @Happypig375 @charlesroddie @FoggyFinder
21+
/.github/release-drafter.yml @Happypig375 @charlesroddie @FoggyFinder
22+
/.github/workflows/ @Happypig375 @charlesroddie @FoggyFinder
23+
/.github/CODEOWNERS @Happypig375 @charlesroddie @FoggyFinder
24+
/.github/PULL_REQUEST_TEMPLATE.md @Happypig375 @charlesroddie @FoggyFinder
25+
/AGENTS.md @Happypig375 @charlesroddie @FoggyFinder
26+
/Contributing.md @Happypig375 @charlesroddie @FoggyFinder
27+
/SECURITY.md @Happypig375 @charlesroddie @FoggyFinder
28+
/ReleaseProcedure.txt @Happypig375 @charlesroddie @FoggyFinder

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Summary
22

3-
<!-- What changes, and why? Keep this focused on behavior a reviewer can verify. -->
3+
<!-- Use a concise title and give a simple description of what changes and why. Keep this focused on behavior a reviewer can verify. -->
44

55
## Related issue
66

@@ -10,10 +10,14 @@
1010

1111
<!-- List the focused tests and broader checks you ran. Include new or updated rendering baselines when applicable. -->
1212

13-
## Compatibility and maintenance cost
13+
## Added code and maintenance
1414

15-
<!-- Note public API, rendering, serialization, platform, migration, added-code, or ongoing-complexity effects. Write "None" when there are none. -->
15+
<!-- Disclose added code, complexity, and ongoing maintenance. Note public API, rendering, serialization, platform, or migration effects. Write "None" when there are none. -->
1616

1717
## Review
1818

19-
<!-- Name any human or automated review beyond routine GitHub checks, and summarize material findings or follow-up fixes. -->
19+
<!-- Name the automated or AI review actually used (do not assume GitHub Copilot is available), and summarize findings and fixes. Write "None" when none was used. -->
20+
21+
## Human judgment
22+
23+
<!-- Flag whether human judgment is needed for feature fit, security, public API, or maintainability. Explain briefly, or write "No". -->

‎AGENTS.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Coding-agent guidance
2+
3+
Follow [Contributing.md](Contributing.md) and [SECURITY.md](SECURITY.md), including
4+
their review policy. Keep pull-request titles concise and descriptions simple. Run
5+
focused validation relevant to the change, inspect the diff and repository for
6+
accidentally exposed secrets without reproducing suspected secrets, and disclose the
7+
actual automated or AI review used and its findings and fixes. Do not assume GitHub
8+
Copilot is available.
9+
10+
Changes to CSharpMath core/editor, CSharpMath.Rendering, CSharpMath.SkiaSharp, their
11+
corresponding tests, or cross-cutting build, release, review, or security
12+
infrastructure require human review. Humans also decide significant feature-fit and
13+
maintainability questions and should check obvious and security mistakes.
14+
15+
Periphery changes (Evaluation/symbolic algebra, other platform frontends or adapters,
16+
examples, benchmarks, and isolated tests) are ready without human GitHub review only
17+
when relevant CI is green, a satisfactory independent LLM review has no unresolved
18+
findings, and no core, public-API, security, release, or cross-cutting concern is
19+
involved. Never claim that any model can never leak secrets; use safe handling and
20+
escalation instead.

‎Contributing.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,17 @@ workflow state. Use draft pull requests for work in progress, milestones for rel
2323
commitments, and native sub-issues and dependencies for larger efforts. When closing
2424
an issue without a merged change, choose the appropriate GitHub state reason so
2525
future readers can distinguish completed work from work that is not planned.
26+
27+
Review policy
28+
-------------
29+
Core changes are changes to CSharpMath core/editor, CSharpMath.Rendering,
30+
CSharpMath.SkiaSharp, their corresponding tests, or cross-cutting build, release,
31+
review, or security infrastructure. Core changes require human review.
32+
33+
Periphery includes symbolic algebra/Evaluation, other platform frontends and adapters,
34+
examples, benchmarks, and isolated tests for those areas. A periphery change may
35+
proceed without human GitHub review only when relevant CI is green, a satisfactory
36+
independent LLM review has no unresolved findings, and it does not involve core code,
37+
a public API, security, release, or another cross-cutting concern. Humans decide
38+
significant feature-fit and maintainability questions and remain important for obvious
39+
or security mistakes.

0 commit comments

Comments
 (0)