docs: Update contribution guidelines to include README.md review process

This commit is contained in:
2026-03-03 18:40:54 -05:00
parent f0ce5a4042
commit 8ee8e5e956
2 changed files with 199 additions and 1 deletions
+11 -1
View File
@@ -176,4 +176,14 @@ After completing any code change, validate in this order:
```powershell
.\build.ps1
```
4. Report test pass/fail counts and build outcome before considering the task complete.
4. **Update `README.md`** — Review the root `README.md` and update it with any information an admin or end-user would need to know as a result of the changes. This includes but is not limited to:
- New or changed CLI commands, flags, or aliases
- New or changed exit codes
- New dependencies
- Changes to build steps or requirements
- New environment variables or configuration
- Changes to supported platforms
- Changes to the project structure (new packages, renamed files)
- Any new prerequisites or setup steps
- Security-relevant changes (e.g. new permissions required)
5. Report test pass/fail counts and build outcome before considering the task complete.