Skip to content

Commit 996e99b

Browse files
Address review comments: fix file paths, grammar, and documentation
Co-authored-by: BreakableHoodie <169505867+BreakableHoodie@users.noreply.github.com>
1 parent 093a96c commit 996e99b

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Default files that appear in all CivicTechWR repositories (unless overridden):
1717
- **SECURITY.md** - Security policy and vulnerability reporting
1818
- **ISSUE_TEMPLATE/** - Issue templates for bugs, features, and questions
1919
- **PULL_REQUEST_TEMPLATE.md** - Pull request template
20+
- **CODEOWNERS** - Default repository ownership and review responsibilities
2021

2122
### Organization Profile
2223

docs/gitleaks-response.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ This guide helps CivicTechWR maintainers triage, contain, and remediate potentia
2525
## 5. Verify and Prevent Recurrence
2626

2727
- Re-run the Gitleaks workflow (or trigger it manually) to confirm the repository is clean.
28-
- Add new patterns to the `gitleaks.toml` allowlist only after validating they are false positives.
28+
- Update the Gitleaks configuration in `.github/workflows/gitleaks.yml` to add new allowlist patterns, and only after validating they are false positives.
2929

3030
## Reference
3131

32-
- Repository workflow: `.github/workflows/reusable-gitleaks.yml`
32+
- Repository workflow: `.github/workflows/gitleaks.yml`
3333
- Team contact: `civictechwr@gmail.com`
3434

3535
Always assume a leaked credential is compromised until rotated and confirmed inactive.

docs/governance/codeowners-branch-protection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Apply these settings to the organization's default branch rule (settings > Code
1515
3. **Required reviewers:**
1616
- At least **1 approval**, prefer **2 approvals** for active codebases.
1717
- **Require review from Code Owners** (once the default CODEOWNERS file lands).
18-
4. **Status checks:** enable the projects primary CI build (e.g., `lint`, `test`, `deploy-preview`). Start with the checks that already exist; new projects should add them before their first release.
18+
4. **Status checks:** enable the project's primary CI build (e.g., `lint`, `test`, `deploy-preview`). Start with the checks that already exist; new projects should add them before their first release.
1919
5. **Additional safeguards:**
2020
- Require conversation resolution before merging.
2121
- Require linear history.
@@ -48,7 +48,7 @@ Projects stay under `@CivicTechWR/organizers` until their project team exists **
4848

4949
## Default CODEOWNERS Strategy
5050

51-
Create `.github/CODEOWNERS` (this repository) so GitHub applies it to every CivicTechWR repo that does not define its own CODEOWNERS file.
51+
Create a repository-root `CODEOWNERS` file (this repository) so GitHub applies it to every CivicTechWR repo that does not define its own CODEOWNERS file.
5252

5353
```text
5454
# Default owners for every file in repos without project-specific CODEOWNERS
@@ -65,7 +65,7 @@ Create `.github/CODEOWNERS` (this repository) so GitHub applies it to every Civi
6565
Key considerations:
6666

6767
- Patterns in this default file must be generic. Repo-specific overrides belong in that repo.
68-
- Github evaluates CODEOWNERS top to bottom; place broader matches last.
68+
- GitHub evaluates CODEOWNERS patterns from top to bottom and uses the last matching pattern. In the examples above, the broad `*` entry appears first so that later, more specific patterns can override it.
6969
- Encourage projects to commit their own CODEOWNERS file as soon as they have a stable team. Provide them with a template (see below) and remind them to keep `@CivicTechWR/organizers` as a secondary owner for continuity.
7070

7171
### Sample project CODEOWNERS template

profile/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Welcome to CivicTech Waterloo Region
22

3-
Please standby—CTWR is coming back to life and taking over.
3+
Please stand by—CTWR is coming back to life and taking over.
44

55
- Visit our website [CivicTechWR.org](https://civictechwr.org/)
66
- Check out what projects are currently happening here: [CTWR Projects In Progress](https://github.com/orgs/CivicTechWR/projects/10/views/6?sliceBy%5Bvalue%5D=In+progress)

0 commit comments

Comments
 (0)