Skip to content

Commit da0f1d2

Browse files
claudehyperpolymath
authored andcommitted
docs(governance): fill required-file placeholders + fix project naming
Fill {{...}} placeholders in .github/CODE_OF_CONDUCT.md and .github/CONTRIBUTING.md and correct project naming to nextgen-typing: - .github/CODE_OF_CONDUCT.md: delete TEMPLATE INSTRUCTIONS block; fill PROJECT_NAME -> nextgen-typing, CONDUCT_EMAIL -> 6759885+hyperpolymath@users.noreply.github.com, CONDUCT_TEAM -> conduct team, RESPONSE_TIME -> 5 working days, CURRENT_YEAR -> 2026, FORGE/OWNER/REPO -> github.com/hyperpolymath/nextgen-typing. - .github/CONTRIBUTING.md: fill FORGE -> github.com, MAIN_BRANCH -> main, OWNER -> hyperpolymath, REPO -> nextgen-typing. Top-level required governance docs and .github/SECURITY.md were already filled by the prior governance wave on main; the OpenSSF compliance gate already passes. Legitimate templates (.machine_readable/ai/*, k9, cliff, ISSUE_TEMPLATE, etc.) left untouched. https://claude.ai/code/session_017TXizM5c1Yd9HWf7Y15YH2
1 parent 4cb28d5 commit da0f1d2

2 files changed

Lines changed: 21 additions & 41 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 11 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,9 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
44
-->
55
# Code of Conduct
66

7-
<!--
8-
============================================================================
9-
TEMPLATE INSTRUCTIONS (delete this block before publishing)
10-
============================================================================
11-
Replace all {{PLACEHOLDER}} values:
12-
{{PROJECT_NAME}} - Your project name
13-
{{OWNER}} - GitHub/GitLab username or org
14-
{{REPO}} - Repository name
15-
{{CONDUCT_EMAIL}} - Email for conduct reports
16-
{{CONDUCT_TEAM}} - Name of conduct team/committee
17-
{{RESPONSE_TIME}} - Initial response SLA (e.g., 48 hours)
18-
{{CURRENT_YEAR}} - Current year
19-
20-
Review and customise:
21-
- Adjust enforcement ladder for your community size
22-
- Add/remove examples based on your context
23-
- Ensure contact methods work for your team
24-
============================================================================
25-
-->
26-
277
## Our Pledge
288

29-
We as members, contributors, and leaders pledge to make participation in {{PROJECT_NAME}} a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.
9+
We as members, contributors, and leaders pledge to make participation in nextgen-typing a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.
3010

3111
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
3212

@@ -140,7 +120,7 @@ If you experience or witness unacceptable behaviour, or have any other concerns,
140120

141121
| Method | Details | Best For |
142122
|--------|---------|----------|
143-
| **Email** | {{CONDUCT_EMAIL}} | Detailed reports, sensitive matters |
123+
| **Email** | 6759885+hyperpolymath@users.noreply.github.com | Detailed reports, sensitive matters |
144124
| **Private Message** | Contact any maintainer directly | Quick questions, minor issues |
145125
| **Anonymous Form** | [Link to form if available] | When you need anonymity |
146126

@@ -156,8 +136,8 @@ If you experience or witness unacceptable behaviour, or have any other concerns,
156136

157137
**What Happens Next**
158138

159-
1. You will receive acknowledgment within **{{RESPONSE_TIME}}**
160-
2. The {{CONDUCT_TEAM}} will review the report
139+
1. You will receive acknowledgment within **5 working days**
140+
2. The conduct team will review the report
161141
3. We may ask for additional information
162142
4. We will determine appropriate action
163143
5. We will inform you of the outcome (respecting others' privacy)
@@ -173,7 +153,7 @@ All reports will be handled with discretion:
173153

174154
### Conflicts of Interest
175155

176-
If a {{CONDUCT_TEAM}} member is involved in an incident:
156+
If a conduct team member is involved in an incident:
177157

178158
- They will recuse themselves from the process
179159
- Another maintainer or external party will handle the report
@@ -183,7 +163,7 @@ If a {{CONDUCT_TEAM}} member is involved in an incident:
183163

184164
## Enforcement Guidelines
185165

186-
The {{CONDUCT_TEAM}} will follow these guidelines in determining consequences:
166+
The conduct team will follow these guidelines in determining consequences:
187167

188168
### 1. Correction
189169

@@ -235,13 +215,13 @@ For contributors with elevated access (Perimeter 2 or 1):
235215
If you believe an enforcement decision was made in error:
236216

237217
1. **Wait 7 days** after the decision (cooling-off period)
238-
2. **Email** {{CONDUCT_EMAIL}} with subject line "Appeal: [Original Report ID]"
218+
2. **Email** 6759885+hyperpolymath@users.noreply.github.com with subject line "Appeal: [Original Report ID]"
239219
3. **Explain** why you believe the decision should be reconsidered
240220
4. **Provide** any new information not previously available
241221

242222
**Appeals Process**
243223

244-
- Appeals are reviewed by a different {{CONDUCT_TEAM}} member than the original
224+
- Appeals are reviewed by a different conduct team member than the original
245225
- You will receive a response within 14 days
246226
- The appeals decision is final
247227
- You may only appeal once per incident
@@ -314,8 +294,8 @@ We thank these communities for their leadership in creating welcoming spaces.
314294

315295
If you have questions about this Code of Conduct:
316296

317-
- Open a [Discussion](https://{{FORGE}}/{{OWNER}}/{{REPO}}/discussions) (for general questions)
318-
- Email {{CONDUCT_EMAIL}} (for private questions)
297+
- Open a [Discussion](https://github.com/hyperpolymath/nextgen-typing/discussions) (for general questions)
298+
- Email 6759885+hyperpolymath@users.noreply.github.com (for private questions)
319299
- Contact any maintainer directly
320300

321301
---
@@ -328,4 +308,4 @@ We're all here because we care about this project. Let's make it a place where e
328308

329309
---
330310

331-
<sub>Last updated: {{CURRENT_YEAR}} · Based on Contributor Covenant 2.1</sub>
311+
<sub>Last updated: 2026 · Based on Contributor Covenant 2.1</sub>

.github/CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ SPDX-License-Identifier: MPL-2.0
33
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
44
-->
55
# Clone the repository
6-
git clone https://{{FORGE}}/{{OWNER}}/{{REPO}}.git
7-
cd {{REPO}}
6+
git clone https://github.com/hyperpolymath/nextgen-typing.git
7+
cd nextgen-typing
88

99
# Using Nix (recommended for reproducibility)
1010
nix develop
1111

1212
# Or using toolbox/distrobox
13-
toolbox create {{REPO}}-dev
14-
toolbox enter {{REPO}}-dev
13+
toolbox create nextgen-typing-dev
14+
toolbox enter nextgen-typing-dev
1515
# Install dependencies manually
1616

1717
# Verify setup
@@ -21,7 +21,7 @@ just test # Run test suite
2121
2222
### Repository Structure
2323
```
24-
{{REPO}}/
24+
nextgen-typing/
2525
├── src/ # Source code (Perimeter 1-2)
2626
├── lib/ # Library code (Perimeter 1-2)
2727
├── extensions/ # Extensions (Perimeter 2)
@@ -62,7 +62,7 @@ just test # Run test suite
6262
6363
**Before reporting**:
6464
1. Search existing issues
65-
2. Check if it's already fixed in `{{MAIN_BRANCH}}`
65+
2. Check if it's already fixed in `main`
6666
3. Determine which perimeter the bug affects
6767
6868
**When reporting**:
@@ -95,10 +95,10 @@ Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) an
9595
9696
Look for issues labelled:
9797
98-
- [`good first issue`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/good%20first%20issue) — Simple Perimeter 3 tasks
99-
- [`help wanted`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/help%20wanted) — Community help needed
100-
- [`documentation`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/documentation) — Docs improvements
101-
- [`perimeter-3`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/perimeter-3) — Community sandbox scope
98+
- [`good first issue`](https://github.com/hyperpolymath/nextgen-typing/labels/good%20first%20issue) — Simple Perimeter 3 tasks
99+
- [`help wanted`](https://github.com/hyperpolymath/nextgen-typing/labels/help%20wanted) — Community help needed
100+
- [`documentation`](https://github.com/hyperpolymath/nextgen-typing/labels/documentation) — Docs improvements
101+
- [`perimeter-3`](https://github.com/hyperpolymath/nextgen-typing/labels/perimeter-3) — Community sandbox scope
102102
103103
---
104104

0 commit comments

Comments
 (0)