Skip to content

docs: condense contributing review notes #792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfoltz merged 1 commit into from
Mar 22, 2026
Merged

docs: condense contributing review notes #792

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 2 additions & 32 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,5 @@

## Review/testing note

- When using the repo-managed environment for local workflow checks, run `bash .codex/install.sh` first so the expected tooling is available before running YAML parsing checks.
- Bash syntax checks such as `bash -n` are not applicable to `.github/workflows/*.yml` files because GitHub Actions workflows are YAML, not shell scripts.
- If shell validation is needed, run `bash .codex/shellcheck.sh` or `bash -n` only against actual `.sh` files or extracted shell snippets, not the workflow YAML itself.
- Local YAML validation warnings against `.github/workflows/release.yml` should be interpreted carefully.
- Direct parser check used during review/testing:

```bash
python3 - <<'PY'
import yaml
PY
```

This check depends on PyYAML being installed. If `import yaml` raises `ModuleNotFoundError: No module named 'yaml'`, treat that as a missing parser dependency in the local environment, not as evidence that `.github/workflows/release.yml` is invalid YAML.
- Guarded variant that separates dependency availability from YAML content validation:

```bash
if ! python3 -c 'import yaml' >/dev/null 2>&1; then
echo "Warning: PyYAML is not installed; skipping YAML parsing check."
else
python3 - <<'PY'
import pathlib
import yaml

workflowPath = pathlib.Path('.github/workflows/release.yml')
with workflowPath.open('r', encoding='utf-8') as workflowFile:
yaml.safe_load(workflowFile)
print(f'Parsed {workflowPath} successfully.')
PY
fi
```

A missing parser dependency is a tooling/setup warning that should be reported separately from workflow syntax or YAML content defects.
- Run `bash .codex/install.sh` before local workflow or tooling checks so the expected repo-managed environment is available.
- Do not run `bash -n` against `.github/workflows/*.yml`; if shell validation is needed, use it only for actual `.sh` files or extracted shell snippets.
Loading