docs: Update contribution guidelines to include README.md review process
This commit is contained in:
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user