mirror of
https://github.com/codewhale-hq/Codewhale.git
synced 2026-11-11 01:51:34 -10:00
docs: say what a planned-work issue gives a contributor; point the roadmap at #7284
CONTRIBUTING gains "What a planned-work issue gives you". Every maintainer-opened planned-work or release tracking issue carries: - its status; - ways to help, with files, a local test command and a done-when, and report-only pieces first; - what maintainers already hold; - how to claim a piece. AGENTS.md makes that a rule for whoever opens such an issue. The six 0.10.3 work items (#7278-#7283) and the tracking issue #7284 were rewritten to that shape and labelled help wanted; #7279 and #7283 also carry good first issue. The ROADMAP's 0.10.3 row now links #7284. It names ACP in both directions and says Codex App Server v2 moved out, per the scope change recorded the same day. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
CodeWhale BotandClaude Opus 5.5 committed
1 parent
c96f2272e7
commit
9731fbbf1c
4 files changed
+15
-3
No files matched your search
@@ -117,6 +117,7 @@ base prompt". Two more corollaries earned here:
|
||||
flag, provider or user-visible feature adds or updates its row in
|
||||
`docs/features.toml` in the same change;
|
||||
`cargo test -p codewhale-tui --test feature_registry` fails on flag drift.
|
||||
- **Public planned-work issues are written for contributors.** An issue opened for planned or release work has the parts in CONTRIBUTING.md § "What a planned-work issue gives you": status, ways to help with files, a local test command and a done-when, what maintainers already hold, and how to claim. Keep it current as pieces land or are claimed.
|
||||
- **Write `close`/`fix`/`resolve #N` only when you mean it.** GitHub closes the
|
||||
issue on merge even inside "does not close #N"; use `Refs #N` otherwise.
|
||||
|
||||
|
||||
@@ -76,6 +76,17 @@ These are always open, and a pull request needs no issue first:
|
||||
Large changes to planned work are easier in layers; see
|
||||
[Layered and EPIC-Sized Work](#layered-and-epic-sized-work).
|
||||
|
||||
### What a planned-work issue gives you
|
||||
|
||||
Every issue a maintainer opens for planned work, and every release tracking issue, has the same parts, so you can pick one up without asking first:
|
||||
|
||||
- **Status:** what is on `main` already, with commit links, and what is still missing.
|
||||
- **Ways to help:** each piece open to contributors, with the files to read, the command to test it locally (usually `scripts/dev-test.sh <crate> <filter>`) and what "done" means. Pieces that need no Rust, such as trying a feature and reporting exactly what happened, are listed first. A precise report is credited like code.
|
||||
- **Being built by maintainers right now:** the parts someone already holds, so you don't build the same thing twice.
|
||||
- **How to take a piece:** comment to claim it, then open a pull request that says `Refs #<issue>`.
|
||||
|
||||
If an issue for planned work is missing one of these, say so on it. That is a bug in the issue.
|
||||
|
||||
## How we work with you
|
||||
|
||||
- We reply by naming what you reported, diagnosed or fixed.
|
||||
|
||||
+1
-1
@@ -126,7 +126,7 @@ holds the next one while it is being built.
|
||||
|
||||
| Milestone | What it is for |
|
||||
| --- | --- |
|
||||
| [0.10.3](https://github.com/codewhale-hq/CodeWhale/milestone/73) | This release is in progress. It fixes undo, sign-in, model selection and install problems reported against 0.10.2, and it adds DeepSeek Harness plugin compatibility, other agents running inside Codewhale and a larger Runtime API. The changelog lists its [known limits](../CHANGELOG.md). |
|
||||
| [0.10.3](https://github.com/codewhale-hq/CodeWhale/milestone/73) | This release is in progress; follow [#7284](https://github.com/codewhale-hq/Codewhale/issues/7284) for what is left and how to help. It fixes undo, sign-in, model selection and install problems reported against 0.10.2, and it adds DeepSeek Harness plugin compatibility and ACP in both directions: other agents running inside Codewhale, and editors driving Codewhale. Codex App Server v2 compatibility moved out of this release. The changelog lists its [known limits](../CHANGELOG.md). |
|
||||
| [0.10.4](https://github.com/codewhale-hq/CodeWhale/milestone/75) | This release improves reliability through process cleanup, resource limits, fail-closed error handling and dead-code removal. |
|
||||
| [0.10.5](https://github.com/codewhale-hq/CodeWhale/milestone/76) | This release improves usability with running-command detail, usage and tool diagnostics, and file previews. |
|
||||
| [0.11](https://github.com/codewhale-hq/CodeWhale/milestone/72) | This release reworks the architecture with smaller crates, provider profiles, one command contract and cache-stable context folding. |
|
||||
|
||||
@@ -361,8 +361,8 @@
|
||||
"sources": [
|
||||
{
|
||||
"path": "CONTRIBUTING.md",
|
||||
"sha256": "440a359c250be850e1a09b157e993e581728b3e7d0867e1feccdfc52df55d22f",
|
||||
"content": "# Contributing to Codewhale\n\nCodewhale is what it is because of the people who used it, reported what broke,\ntranslated it, added their providers and sent fixes. Thank you for being here.\nEveryone is welcome, in English or 中文, with or without code.\n\nAll feedback is a gift to this project, including \"this looked wrong\" or \"I got\nlost here\" with no fix attached. The [roadmap](docs/ROADMAP.md) says where\nCodewhale is going and where help counts most.\n\n## Where things go\n\n| You have | Best place |\n| --- | --- |\n| A bug, a crash, or behavior that surprised you | [Bug report](https://github.com/codewhale-hq/CodeWhale/issues/new?template=bug_report.yml) |\n| An idea or a feature you want | [Feature request](https://github.com/codewhale-hq/CodeWhale/issues/new?template=feature_request.yml), or [Ideas](https://github.com/codewhale-hq/CodeWhale/discussions/categories/ideas) to talk it through first |\n| Feedback on how something looks, reads or feels | [Feedback](https://github.com/codewhale-hq/CodeWhale/issues/new?template=feedback.yml) |\n| A question | [Q&A](https://github.com/codewhale-hq/CodeWhale/discussions/categories/q-a) or [Discord](https://discord.gg/37gfS3ksug) |\n| A security problem | A [private advisory](https://github.com/codewhale-hq/CodeWhale/security/advisories/new), never a public issue ([policy](.github/SECURITY.md)) |\n| A fix for an open issue | A pull request that links the issue |\n| A translation, a provider or model, a docs fix | A pull request, no issue needed ([standing projects](#standing-projects)) |\n| A new feature, already written or not | An issue first ([why](#new-features-start-as-an-issue)) |\n\nIf you are not sure, open an issue. Nothing is filed in the wrong place for\nlong: a maintainer moves it.\n\n## New features start as an issue\n\nIssues are the best place for feature requests, ideas and bugs. A pull request\nis the best place for work we have already agreed on.\n\nA feature that first appears as a pull request takes longer to land than one\nthat starts as an issue, even when we want it. The questions that decide a\nfeature are about the product, not the diff: does it belong in the engine or in\na plugin, what does it do in each permission mode, how does it show up in\nreceipts, what is it called in 19 languages. Answering those in a review means\nrewriting code you already finished. Answering them in an issue costs you a few\nsentences.\n\nSo for a new feature:\n\n1. Open a [feature request](https://github.com/codewhale-hq/CodeWhale/issues/new?template=feature_request.yml).\n Say what you are trying to do and what gets in the way. A proposed design is\n welcome and optional.\n2. Tick \"I would like to open a pull request\" if you want to build it.\n3. A maintainer answers with the shape that fits, or with what is still\n undecided. Then the pull request is small and merges quickly.\n\nA feature pull request that arrives without an issue is still read, and it is\nnever closed for that reason. We will most likely ask the same questions there\nand it will take longer.\n\n## Standing projects\n\nThese are always open, and a pull request needs no issue first:\n\n- **Translations.** You can improve the terminal language packs, the translated\n READMEs in `docs/i18n/`, the website, and the translated docs in\n `docs/zh_hans/` and `docs/id/`. The [localization matrix](docs/LOCALIZATION.md)\n shows what each language has and how to add one, and the\n [Chinese localization group](https://github.com/codewhale-hq/CodeWhale/issues/6804)\n is recruiting.\n- **Providers and models.** You can add a missing provider or a new model, or\n correct a price, a context size or a provider quirk.\n [Providers](docs/PROVIDERS.md) lists what ships, and\n `python3 scripts/check-provider-registry.py` checks your change.\n- **Documentation.** You can fix a typo, an unclear step, a missing example or\n an instruction that no longer matches the product.\n- **Bug fixes.** If there is no issue yet, describe the bug in the pull request\n by saying what you ran, what happened and what you expected.\n- **Planned work.** You can take anything in a\n [milestone](docs/ROADMAP.md#releases) or anything labelled\n [help wanted](https://github.com/codewhale-hq/CodeWhale/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).\n Comment on the issue to claim it so two people do not build the same thing.\n\nLarge changes to planned work are easier in layers; see\n[Layered and EPIC-Sized Work](#layered-and-epic-sized-work).\n\n## How we work with you\n\n- We reply by naming what you reported, diagnosed or fixed.\n- Your pull request merges as itself, with you as the author\n ([details](#how-your-contribution-lands)).\n- You do not rebase around our changes, and a red check you did not cause is\n ours to fix.\n- We credit you in the changelog and in\n [the contributors list](docs/CONTRIBUTORS.md).\n- If something is not ready or not a fit, we say what iLine truncated
|
||||
"sha256": "7b3e523585eb5535555b1d8aaa66153ce0451b1cedc165dfba212e372dd71d41",
|
||||
"content": "# Contributing to Codewhale\n\nCodewhale is what it is because of the people who used it, reported what broke,\ntranslated it, added their providers and sent fixes. Thank you for being here.\nEveryone is welcome, in English or 中文, with or without code.\n\nAll feedback is a gift to this project, including \"this looked wrong\" or \"I got\nlost here\" with no fix attached. The [roadmap](docs/ROADMAP.md) says where\nCodewhale is going and where help counts most.\n\n## Where things go\n\n| You have | Best place |\n| --- | --- |\n| A bug, a crash, or behavior that surprised you | [Bug report](https://github.com/codewhale-hq/CodeWhale/issues/new?template=bug_report.yml) |\n| An idea or a feature you want | [Feature request](https://github.com/codewhale-hq/CodeWhale/issues/new?template=feature_request.yml), or [Ideas](https://github.com/codewhale-hq/CodeWhale/discussions/categories/ideas) to talk it through first |\n| Feedback on how something looks, reads or feels | [Feedback](https://github.com/codewhale-hq/CodeWhale/issues/new?template=feedback.yml) |\n| A question | [Q&A](https://github.com/codewhale-hq/CodeWhale/discussions/categories/q-a) or [Discord](https://discord.gg/37gfS3ksug) |\n| A security problem | A [private advisory](https://github.com/codewhale-hq/CodeWhale/security/advisories/new), never a public issue ([policy](.github/SECURITY.md)) |\n| A fix for an open issue | A pull request that links the issue |\n| A translation, a provider or model, a docs fix | A pull request, no issue needed ([standing projects](#standing-projects)) |\n| A new feature, already written or not | An issue first ([why](#new-features-start-as-an-issue)) |\n\nIf you are not sure, open an issue. Nothing is filed in the wrong place for\nlong: a maintainer moves it.\n\n## New features start as an issue\n\nIssues are the best place for feature requests, ideas and bugs. A pull request\nis the best place for work we have already agreed on.\n\nA feature that first appears as a pull request takes longer to land than one\nthat starts as an issue, even when we want it. The questions that decide a\nfeature are about the product, not the diff: does it belong in the engine or in\na plugin, what does it do in each permission mode, how does it show up in\nreceipts, what is it called in 19 languages. Answering those in a review means\nrewriting code you already finished. Answering them in an issue costs you a few\nsentences.\n\nSo for a new feature:\n\n1. Open a [feature request](https://github.com/codewhale-hq/CodeWhale/issues/new?template=feature_request.yml).\n Say what you are trying to do and what gets in the way. A proposed design is\n welcome and optional.\n2. Tick \"I would like to open a pull request\" if you want to build it.\n3. A maintainer answers with the shape that fits, or with what is still\n undecided. Then the pull request is small and merges quickly.\n\nA feature pull request that arrives without an issue is still read, and it is\nnever closed for that reason. We will most likely ask the same questions there\nand it will take longer.\n\n## Standing projects\n\nThese are always open, and a pull request needs no issue first:\n\n- **Translations.** You can improve the terminal language packs, the translated\n READMEs in `docs/i18n/`, the website, and the translated docs in\n `docs/zh_hans/` and `docs/id/`. The [localization matrix](docs/LOCALIZATION.md)\n shows what each language has and how to add one, and the\n [Chinese localization group](https://github.com/codewhale-hq/CodeWhale/issues/6804)\n is recruiting.\n- **Providers and models.** You can add a missing provider or a new model, or\n correct a price, a context size or a provider quirk.\n [Providers](docs/PROVIDERS.md) lists what ships, and\n `python3 scripts/check-provider-registry.py` checks your change.\n- **Documentation.** You can fix a typo, an unclear step, a missing example or\n an instruction that no longer matches the product.\n- **Bug fixes.** If there is no issue yet, describe the bug in the pull request\n by saying what you ran, what happened and what you expected.\n- **Planned work.** You can take anything in a\n [milestone](docs/ROADMAP.md#releases) or anything labelled\n [help wanted](https://github.com/codewhale-hq/CodeWhale/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).\n Comment on the issue to claim it so two people do not build the same thing.\n\nLarge changes to planned work are easier in layers; see\n[Layered and EPIC-Sized Work](#layered-and-epic-sized-work).\n\n### What a planned-work issue gives you\n\nEvery issue a maintainer opens for planned work, and every release tracking issue, has the same parts, so you can pick one up without asking first:\n\n- **Status:** what is on `main` already, with commit links, and what is still missing.\n- **Ways to help:** each piece open to contributors, with the files to read, the command to test it locally (usually `scripts/dev-test.sh <crate> <filter>Line truncated
|
||||
},
|
||||
{
|
||||
"path": "docs/AGENT_ETHOS.md",
|
||||
|
||||
Reference in new issue
Block a user