Skip to content

Commit f10b231

Browse files
committed
docs: add balance checkpoints to maintainer workflow
1 parent 299bb54 commit f10b231

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

CHANGELOG.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,13 @@ Ideas that will be planned and find their way into a release at one point
2828
- [ ] Parse `require`s with ts-morph. Then we can add dependencies back to website
2929
- [ ] website: Render authors server-side
3030
- [ ] website: Fix the search functionality
31-
- [ ] Verification: verify examples against native runtimes (PHP/Go/Python/Ruby/C) with Docker
32-
- [x] `yarn verify` and `yarn verify:php` scripts added
33-
- [x] Docker-based PHP verification working (62/91 string functions pass, 68.1%)
34-
- [x] Parallel execution with p-map (8x concurrency)
35-
- [x] Cache invalidation when verify.ts changes
36-
- [x] Strip PHP warnings from output, fix object literal translation, string-aware property access
37-
- [x] JSON forward slash normalization, skip language constructs (echo)
38-
- [ ] Remaining 29 failures: Unicode handling, pass-by-ref patterns, implementation differences
31+
- [ ] Verification: verify examples against native runtimes with Docker (balance efforts across languages)
32+
- [x] PHP: 62/91 (68%) - remaining: Unicode, pass-by-ref, complex edge cases
33+
- [ ] Go: not implemented (Docker image configured but verification skipped)
34+
- [ ] Python: not implemented
35+
- [ ] Ruby: not implemented
36+
- [ ] C: not implemented
37+
- [x] Infrastructure: parallel execution, caching, PHP warning stripping
3938
- [ ] CI integration: fail if verification diverges
4039
- [ ] Badge: "Verified against PHP 8.3"
4140
- [ ] Modernize, e.g.:

CORE_MAINTAINER.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,16 @@ Note that for any task, it's important to first get ample context. Search past i
2020
2. Use `gh` to check on pending PRs. First run `gh auth status` to understand what our GitHub identity is. Make sure all PRs have reviews by other people than our identity (fixable only when PRs are submitted by others), that PRs pass (fixable only if they were submitted by US), fix what can be fixed, then re-check next iteration. If all is green, merge. LLMs should refrain from commenting on PRs, but deep reviews on PRs by others are allowed.
2121
3. Triage issues. Confirm repro, decide scope, and say no when needed to protect project goals (see `## Vision`, `README.md`, `CHANGELOG.md`, and `website/source/about.md`). LLMs should refrain from commenting on Issues.
2222
4. To continuously modernize the project, revise the Backlog/Roadmap in `CHANGELOG.md`. Don't forget about the website, which lives in this repo and is deployed via GHA. Check off items and/or move them into releases as appropriate.
23-
5. Decide an issue to work on. Attempt to balance time spent over different areas. It could come from
23+
5. Decide an issue to work on. **Before starting, check:** What areas have received attention in the last 5 iterations? Prioritize neglected areas. Balance time across: verification (all languages), modernization, TypeScript, website, dependencies.
24+
25+
It could come from:
2426
- a security concern
25-
- the Backlog/Roadmap in `CHANGELOG.md`. Attampt to balance time spent in different parts of this, too
27+
- the Backlog/Roadmap in `CHANGELOG.md` (balance across different items)
2628
- a verified GitHub issue
2729
- a PR failure
2830
- upgrading outdated dependencies, checking release notes, taking care of the potential migration, leveraging new capabilities
2931
- unfinished business
30-
32+
3133
Do what is most important and impactful first. First search what is already available, and what we can already re-use, even if it takes a little refactoring. Define what a successful outcome looks like and how you'll validate it (tests, browser checks, screenshots for design changes, or a working migration). This is imperative: no changes without validation. Anything that can't be validated should not be PR'ed or merged.
3234
6. **NEVER commit directly to `main`.** Always create or (re-use, see `Batching Related Work`) another branch and open a PR:
3335
```bash

docs/prompts/LOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ LLMs log key learnings, progress, and next steps in one `### Iteration ${increme
66

77
- An iteration starts with a level 3 heading: `### Iteration ${incrementing number}`
88
- An iteration contains the datetime, and a list of bullet points
9+
- Each iteration should note which backlog area was touched (e.g., verification, modernization, TypeScript, website, dependencies)
10+
- Every 10 iterations, review balance: have different backlog areas been addressed, or has one area dominated?
911
- Every 10 iterations must be summarized and compacted into one list of bullet points, e.g. `### Iterations 1-10`.
1012
- If you write to this file and find any violation, revise this document to make it adhere
1113

0 commit comments

Comments
 (0)