docs: add source-of-truth templates#240
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Droid finished @EffortlessSteven's task —— View job Droid is reviewing code and running a security check… |
There was a problem hiding this comment.
Code Review
This pull request introduces a set of standardized templates for project documentation, including ADRs, proposals, specifications, implementation plans, and goal manifests. It also updates the non-rust-allowlist policy to accommodate the new goal manifest files. The review feedback focuses on improving consistency across these templates by suggesting standardized ID formats and ensuring uniform pluralization for metadata fields like 'Linked proposals' and 'Linked plans' across all document types.
| @@ -0,0 +1,19 @@ | |||
| id = "shipper-goal-id" | |||
There was a problem hiding this comment.
For consistency with the work item ID below and to provide a clearer signal for users to fill in the field, consider using an empty string for the top-level goal ID.
| id = "shipper-goal-id" | |
| id = "" |
References
- Maintain consistency in placeholder values within templates to improve clarity for future users.
| @@ -0,0 +1,37 @@ | |||
| # Plan: Title | |||
There was a problem hiding this comment.
To maintain consistency with the naming convention used in ADR, Proposal, and Spec templates, consider using a prefixed ID placeholder for implementation plans.
| # Plan: Title | |
| # SHIPPER-PLAN-0000: Title |
References
- Ensure consistent document identification patterns across all project templates.
| Linked proposal: | ||
| Linked specs: | ||
| Linked ADRs: | ||
| Linked plan: |
There was a problem hiding this comment.
Pluralize 'Linked proposal' and 'Linked plan' to match the pluralization of 'Linked specs', 'Linked ADRs', 'Linked issues', and 'Linked PRs' in the metadata block.
| Linked proposal: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plan: | |
| Linked proposals: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plans: |
References
- Use consistent pluralization for collection-like metadata fields in documentation templates.
|
|
||
| ### PR 1 - Title | ||
|
|
||
| Linked spec: |
There was a problem hiding this comment.
Consider pluralizing 'Linked spec' to 'Linked specs' for consistency with the top-level metadata block.
| Linked spec: | |
| Linked specs: |
References
- Maintain consistent terminology and pluralization throughout the document.
| Linked proposal: | ||
| Linked specs: | ||
| Linked ADRs: | ||
| Linked plan: |
There was a problem hiding this comment.
Pluralize 'Linked proposal' and 'Linked plan' to match the pluralization of other fields in this metadata block.
| Linked proposal: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plan: | |
| Linked proposals: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plans: |
References
- Use consistent pluralization for collection-like metadata fields in documentation templates.
| Linked proposal: | ||
| Linked specs: | ||
| Linked ADRs: | ||
| Linked plan: |
There was a problem hiding this comment.
Pluralize 'Linked proposal' and 'Linked plan' to match the pluralization of other fields in this metadata block.
| Linked proposal: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plan: | |
| Linked proposals: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plans: |
References
- Use consistent pluralization for collection-like metadata fields in documentation templates.
| Linked proposal: | ||
| Linked specs: | ||
| Linked ADRs: | ||
| Linked plan: |
There was a problem hiding this comment.
Pluralize 'Linked proposal' and 'Linked plan' to match the pluralization of other fields in this metadata block.
| Linked proposal: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plan: | |
| Linked proposals: | |
| Linked specs: | |
| Linked ADRs: | |
| Linked plans: |
References
- Use consistent pluralization for collection-like metadata fields in documentation templates.
Summary
.shipper-meta/goals/TEMPLATE.tomlfor future active goal manifests.shipper-meta/goals/*.tomlin the non-Rust file policy ledgerScope boundary
This is PR 2 only: templates plus the required TOML receipt. It intentionally does not add support tiers, concrete proposal/spec/ADR artifacts, active goals, doc-contract checker code, CI changes, or #195 release proof work.
Validation
python -c "import pathlib,tomllib; tomllib.loads(pathlib.Path('.shipper-meta/goals/TEMPLATE.toml').read_text()); print('goal template TOML parses')"cargo fmt --all -- --checkcargo xtask check-file-policy --mode blocking-allowlistcargo xtask policy-report