Add code review standards: Copilot config, reviewer guide, and CI enforcement by Copilot · Pull Request #221 · lcn2/calc

Copilot · 2026-10-04T00:28:29Z

Encodes three review standards for calc: no goto in C, tests must pass, and no typos in docs or code comments. They are written into Copilot code review config and a human-facing guide, and enforced by PR workflows. No C source is modified.

Copilot config
- .github/copilot/code-review-instructions.md holds the three standards.
- .github/copilot-instructions.md carries the repo-wide rules.
- .github/instructions/*.instructions.md are path-scoped via applyTo: c-code and comments apply to **/*.c,**/*.h; docs applies to **/*.md,**/*.txt,help/**.
.github/CODE_REVIEW_GUIDE.md
- Covers rationale and alternatives for the no-goto rule, the local test commands, and the typo-check usage.
- Includes a reviewer checklist and how the Copilot config and workflows fit together.
Workflows (.github/workflows/): all trigger on pull_request (opened, synchronize, reopened) to master, with contents: read and fetch-depth: 0.
- no-goto.yml scans only added lines in *.c/*.h and strips strings and comments before matching. It prints file:line for each offender.
- tests.yml installs the build dependencies, then runs make clobber all, make check, and make chk.
- typos.yml runs crate-ci/typos@v1 on changed .c, .h, .md, .txt, .1, and help/* files only.
_typos.toml: excludes generated and vendored paths and cal/, and allows project terms.

Review focus:

The _typos.toml exclusions and allow-list are a first guess. Expect to tune them against real runs.
The comment and string stripping in the no-goto awk script is heuristic. It won't handle multi-line block comments beyond skipping lines that start with *.
The existing test.yml also runs on PRs, so builds run twice. Consider retiring it in favour of tests.yml.

Follow-up (repo settings): mark these as required status checks in branch protection:

workflow "No goto", job no-goto
workflow "Tests", job tests
workflow "Typos", job typos

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

lcn2 · 2026-10-04T00:56:39Z

I see a number of new files under .github. I have some additional requirements and refinements to the added files. Should I attempt to directly modify PR 221, or work with you in this chat, or work with the PR 221, or ???

lcn2

I have some additional requirements and refinements to the added files. Should I attempt to directly modify PR 221, or work with you in this chat, or work with the PR 221, or ???

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

lcn2

The Code Review Guide needs to be extended as follows:

The code must be portable to the current versions of macOS, RHEL Linux, and NetBSD
The calc code must be CPU byte-order independent: make chk must work on both Little Endian (Apple Silicon arm64, and x86_64), and Big Endian (s390x) hardware.
The documentation to be checked includes the files under the help/ directory: these must be included in the checks for typos and consistency.
The documentation to be checked also includes BUSG, calc.man, CHANGES, CONTRIB-CODE, HOWTO.INSTALL, LIBRARY, README.FIRST, README.md, README.RELEASE, README.WINDOWS, sample.README, SECURITY.md.
The ./trailblank script must run without error.
The ./trailblank script must also ignore files under the .github/ sub-directory.
The C code must conform to the format specified in .clang-format such that when make clang-format is run, the clang-format(1) tool does not need to modify any files.
When a new version of calc is created, the CHANGES file must be updated with comments about the new version, including details of what changed.
The cal/regress.cal regression test suite must NOT assume that the calc executable is in the local directory, and should not attempt to invoke the calc executable.

Copilot

Copilot review overview

🟡 Changes recommended

The new enforcement misses maintained sources, includes an ignored Copilot configuration, and can reject valid multiline comments.

Review effort: Balanced
Findings: 4 · 1

Open (5)

Move review guidance to a supported Copilot instruction file · New
Handle multiline block comments when detecting added goto statements · New
Include calc.man in the man-page typo check pathspec · New
Do not exclude maintained lib_calc source files from review · New
Include all .man sources in review instruction scope · New

What changed in this PR

Adds repository review standards, documentation, and CI enforcement for C control flow, testing, and spelling.

Changes:

Adds Copilot and contributor review guidance.
Adds PR workflows for tests, typo checks, and goto detection.
Configures typo exclusions and formatting-tool behavior.

File	Description
`trailblank`	Excludes `.github` from picky phase 1.
`.github/workflows/typos.yml`	Checks changed files for typos.
`.github/workflows/tests.yml`	Builds and runs regression checks.
`.github/workflows/no-goto.yml`	Detects added `goto` statements.
`.github/instructions/docs.instructions.md`	Adds documentation review guidance.
`.github/instructions/comments.instructions.md`	Adds C-comment spelling guidance.
`.github/instructions/c-code.instructions.md`	Adds C review requirements.
`.github/copilot/code-review-instructions.md`	Adds review standards at an unsupported path.
`.github/copilot-instructions.md`	Defines repository-wide Copilot instructions.
`.github/CODE_REVIEW_GUIDE.md`	Documents standards and enforcement.
`_typos.toml`	Configures typo exclusions and vocabulary.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot · 2026-10-04T01:57:32Z

+# Copilot code review standards for lcn2/calc
+
+Apply these rules when reviewing pull requests.


Removed the unsupported duplicate instruction file and its guide reference in commit 02055f5.

Copilot · 2026-10-04T01:57:32Z

+            gsub(/\/\*.*\*\//, "", t)
+            sub(/\/\/.*/, "", t)
+            if (t ~ /^[ \t]*\*/ ) next
+            if (t ~ /(^|[^A-Za-z0-9_])goto([^A-Za-z0-9_]|$)/) {


Updated the workflow to scan full-file C lexical state before checking added lines, so multiline comments are ignored in commit 02055f5.

Copilot · 2026-10-04T01:57:32Z

+      run: |
+        files=$(git diff --name-only --diff-filter=ACMR \
+          "origin/${{ github.base_ref }}...HEAD" -- \
+          '*.c' '*.h' '*.md' '*.txt' '*.1' 'help/*' | tr '\n' ' ')


Added *.man to the changed-file pathspec in commit 02055f5.

Copilot · 2026-10-04T01:57:32Z

@@ -0,0 +1,5 @@
+---
+applyTo: "**/*.md,**/*.txt,help/**"


Added **/*.man to the docs instruction scope in commit 02055f5.

lcn2

@copilot please update the Code Review Guide, copilot instructions, code review instructions to indicate that:

The C code must conform clang-format options as found the .clang-format file, such that when make clang-format is run, the clang-format(1) tool does not need to modify any files.

Pease add workflows to ensure that the code confirms too clang-format options as found the .clang-format file, such that when make clang-format is run, the clang-format(1) tool does not need to modify any files.

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot · 2026-10-04T01:48:45Z

@copilot please update the Code Review Guide, copilot instructions, code review instructions to indicate that:

The C code must conform clang-format options as found the .clang-format file, such ...

Added the clang-format requirement to the review guidance and Copilot instructions, plus a PR workflow that runs make clang-format and fails if any tracked files change. The change is committed as COMMIT_HASH.

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

lcn2

Please move the _typos.toml somewhere under the .github directory, if possible, or if not, rename it to .typos.toml so that the file is "hidden" for normal ls views.

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

lcn2

@copilot please move _typos.toml under the .github/ sub-directory.

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot · 2026-10-04T02:26:37Z

@copilot please move _typos.toml under the .github/ sub-directory.

Moved the config to .github/_typos.toml and updated its references in commit 7c2afb1.

lcn2

🤖👍

Initial plan

38facb5

Copilot AI assigned Copilot and lcn2 Oct 4, 2026

Copilot started work on behalf of lcn2 October 4, 2026 00:28

View session

Add code review config, guide, and enforcement workflows

5aa7668

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add code review requirements and automated enforcement~~ Add code review standards: Copilot config, reviewer guide, and CI enforcement Oct 4, 2026

Copilot finished work on behalf of lcn2 October 4, 2026 00:30

Copilot AI requested a review from lcn2 October 4, 2026 00:30

lcn2 requested changes Oct 4, 2026

View reviewed changes

Copilot started work on behalf of lcn2 October 4, 2026 00:58

View session

Copilot finished work on behalf of lcn2 October 4, 2026 00:58

Copilot AI requested a review from lcn2 October 4, 2026 00:58

Copilot started work on behalf of lcn2 October 4, 2026 01:00

View session

Copilot AI and others added 2 commits October 4, 2026 01:01

Plan exclude GitHub config from picky

7168b7f

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Exclude GitHub files from picky checks

05539ef

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot finished work on behalf of lcn2 October 4, 2026 01:04

lcn2 requested changes Oct 4, 2026

View reviewed changes

Copilot started work on behalf of lcn2 October 4, 2026 01:25

View session

Copilot finished work on behalf of lcn2 October 4, 2026 01:26

Copilot AI requested a review from lcn2 October 4, 2026 01:26

lcn2 marked this pull request as ready for review October 4, 2026 01:37

Copilot AI balanced review requested due to automatic review settings October 4, 2026 01:37

Copilot started reviewing on behalf of lcn2 October 4, 2026 01:37

View session

Copilot AI reviewed Oct 4, 2026

View reviewed changes

lcn2 requested changes Oct 4, 2026

View reviewed changes

Copilot started work on behalf of lcn2 October 4, 2026 01:46

View session

Add clang-format review requirement and check

0a513a6

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot finished work on behalf of lcn2 October 4, 2026 01:49

Copilot AI requested a review from lcn2 October 4, 2026 01:49

Copilot started work on behalf of lcn2 October 4, 2026 01:55

View session

Fix review feedback on repository checks

02055f5

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot finished work on behalf of lcn2 October 4, 2026 01:58

lcn2 requested changes Oct 4, 2026

View reviewed changes

Copilot started work on behalf of lcn2 October 4, 2026 02:07

View session

Copilot finished work on behalf of lcn2 October 4, 2026 02:09

Copilot AI requested a review from lcn2 October 4, 2026 02:09

Copilot started work on behalf of lcn2 October 4, 2026 02:12

View session

Format addop and help sources with clang-format 23

4d44547

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot finished work on behalf of lcn2 October 4, 2026 02:16

lcn2 requested changes Oct 4, 2026

View reviewed changes

Copilot started work on behalf of lcn2 October 4, 2026 02:24

View session

Move typos config under .github

7c2afb1

Co-authored-by: lcn2 <10429707+lcn2@users.noreply.github.com>

Copilot finished work on behalf of lcn2 October 4, 2026 02:27

Copilot AI requested a review from lcn2 October 4, 2026 02:27

lcn2 approved these changes Oct 4, 2026

View reviewed changes

lcn2 merged commit c8edd3e into master Oct 4, 2026
8 checks passed

lcn2 deleted the copilot/add-code-review-requirements branch October 4, 2026 02:38

		# Copilot code review standards for lcn2/calc

		Apply these rules when reviewing pull requests.

Conversation

Copilot AI commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lcn2 commented Oct 4, 2026

Uh oh!

lcn2 left a comment

Choose a reason for hiding this comment

Uh oh!

lcn2 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Copilot AI Oct 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Oct 4, 2026

Choose a reason for hiding this comment

Uh oh!

lcn2 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 4, 2026

Uh oh!

lcn2 left a comment

Choose a reason for hiding this comment

Uh oh!

lcn2 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 4, 2026

Uh oh!

lcn2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Oct 4, 2026 •

edited

Loading