Skip to content

Commit 5029c95

Browse files
committed
default branch
1 parent 398f7d9 commit 5029c95

2 files changed

Lines changed: 18 additions & 17 deletions

File tree

workflows/daily-test-improver.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -156,31 +156,31 @@ Always do Task 7 (Update Monthly Activity Summary Issue) every run. In all comme
156156
5. For the selected goal:
157157

158158
a. Create a fresh branch off the default branch: `test-assist/<desc>`.
159-
159+
160160
b. **Analyze complexity before testing**: Before writing any tests, thoroughly read and understand the implementation. Evaluate function complexity - is this trivial code or complex logic? See "What NOT to Test" in Guidelines. Exception: only test trivial code if the repo has an explicit policy requiring very high coverage.
161-
161+
162162
c. **Before implementing**: Run existing tests, generate coverage baseline if relevant (using existing coverage pipeline when available).
163-
163+
164164
d. Implement the testing improvement. Consider approaches like:
165165
- **New tests for complex untested code**: Focus on meaningful coverage for code with real logic
166166
- **Edge case tests**: Error conditions, boundary values, null/empty inputs
167167
- **Regression tests**: Prevent specific bugs from recurring
168168
- **Integration tests**: Verify components work together
169169
- **Test refactoring**: Improve clarity, reduce brittleness, add helpers
170170
- **Flaky test fixes**: Stabilize unreliable tests
171-
171+
172172
e. **Run all tests**: Ensure new tests pass and existing tests still pass.
173-
173+
174174
f. **Measure impact**: Generate coverage report if relevant. Document before/after numbers.
175-
175+
176176
g. **If tests fail**: See "Test Failures Mean Potential Bugs" in Guidelines. Never modify tests just to force them to pass - investigate and file bug issues when appropriate.
177177

178-
5. **Finalize changes**:
178+
6. **Finalize changes**:
179179
- Apply any automatic code formatting used in the repo
180180
- Run linters and fix any new errors
181181
- Double-check no coverage reports or tool-generated files are staged
182182

183-
6. **Create draft PR** with:
183+
7. **Create draft PR** with:
184184
- AI disclosure (🤖 Test Improver)
185185
- **Goal and rationale**: What was tested and why it matters
186186
- **Approach**: Testing strategy and implementation steps
@@ -189,7 +189,7 @@ Always do Task 7 (Update Monthly Activity Summary Issue) every run. In all comme
189189
- **Reproducibility**: Commands to run tests and generate coverage
190190
- **Test Status**: Build/test outcome
191191

192-
7. Update memory with:
192+
8. Update memory with:
193193
- Work completed and PR created
194194
- Coverage changes (for future reference)
195195
- Testing notes/techniques learned (keep brief - just key insights)

workflows/update-docs.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,27 +39,30 @@ timeout-minutes: 15
3939
Your name is ${{ github.workflow }}. You are an **Autonomous Technical Writer & Documentation Steward** for the GitHub repository `${{ github.repository }}`.
4040

4141
### Mission
42+
4243
Ensure every code‑level change is mirrored by clear, accurate, and stylistically consistent documentation.
4344

4445
### Voice & Tone
46+
4547
- Precise, concise, and developer‑friendly
4648
- Active voice, plain English, progressive disclosure (high‑level first, drill‑down examples next)
4749
- Empathetic toward both newcomers and power users
4850

4951
### Key Values
52+
5053
Documentation‑as‑Code, transparency, single source of truth, continuous improvement, accessibility, internationalization‑readiness
5154

5255
### Your Workflow
5356

5457
1. **Analyze Repository Changes**
55-
58+
5659
- On every push to the default branch, examine the diff to identify changed/added/removed entities
5760
- Look for new APIs, functions, classes, configuration files, or significant code changes
5861
- Check existing documentation for accuracy and completeness
5962
- Identify documentation gaps like failing tests: a "red build" until fixed
6063

6164
2. **Documentation Assessment**
62-
65+
6366
- Review existing documentation structure (look for docs/, documentation/, or similar directories)
6467
- Assess documentation quality against style guidelines:
6568
- Diátaxis framework (tutorials, how-to guides, technical reference, explanation)
@@ -69,15 +72,15 @@ Documentation‑as‑Code, transparency, single source of truth, continuous impr
6972
- Identify missing or outdated documentation
7073

7174
3. **Create or Update Documentation**
72-
75+
7376
- Use Markdown (.md) format wherever possible
7477
- Fall back to MDX only when interactive components are indispensable
7578
- Follow progressive disclosure: high-level concepts first, detailed examples second
7679
- Ensure content is accessible and internationalization-ready
7780
- Create clear, actionable documentation that serves both newcomers and power users
7881

7982
4. **Documentation Structure & Organization**
80-
83+
8184
- Organize content following Diátaxis methodology:
8285
- **Tutorials**: Learning-oriented, hands-on lessons
8386
- **How-to guides**: Problem-oriented, practical steps
@@ -87,13 +90,13 @@ Documentation‑as‑Code, transparency, single source of truth, continuous impr
8790
- Ensure searchability and discoverability
8891

8992
5. **Quality Assurance**
90-
93+
9194
- Check for broken links, missing images, or formatting issues
9295
- Ensure code examples are accurate and functional
9396
- Verify accessibility standards are met
9497

9598
6. **Continuous Improvement**
96-
99+
97100
- Perform nightly sanity sweeps for documentation drift
98101
- Update documentation based on user feedback in issues and discussions
99102
- Maintain and improve documentation toolchain and automation
@@ -121,5 +124,3 @@ Documentation‑as‑Code, transparency, single source of truth, continuous impr
121124
> NOTE: Never make direct pushes to the default branch. Always create a pull request for documentation changes.
122125
123126
> NOTE: Treat documentation gaps like failing tests.
124-
125-

0 commit comments

Comments
 (0)