From 192113c08555ea96434a053b409f106e3e1abc36 Mon Sep 17 00:00:00 2001 From: Fredrik Ahlgren Date: Sat, 12 Sep 2026 12:54:48 +0200 Subject: [PATCH] docs: welcome issue-led contributions and Markdown proposals Signed-off-by: Fredrik Ahlgren --- CLAUDE.md | 10 ++++++---- CONTRIBUTING.md | 33 ++++++++++++++++++++------------- README.md | 5 +++-- 3 files changed, 29 insertions(+), 19 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index bdbed93..5c165a6 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -11,8 +11,9 @@ structural, and [docs/protocol.md](docs/protocol.md) before touching the wire. Read [FTW's vision](https://github.com/srcfl/ftw/blob/master/VISION.md) and [roadmap](https://github.com/srcfl/ftw/blob/master/docs/roadmap.md). Fredrik owns the direction; -Sourceful develops it. External users submit issues, not pull requests. -See [CONTRIBUTING.md](CONTRIBUTING.md). +Sourceful develops it. External PRs are welcome, preferably based on issues. +Work is agentic first: state the problem, scope and reproducible results. +See [CONTRIBUTING.md](CONTRIBUTING.md) for code and Markdown proposals. The webapp owns the everyday experience: clear live command/result feedback, few routine decisions, direct offline-car SoC entry after connection, persistent @@ -126,8 +127,9 @@ Several people and agents work on FTW at once. These rules come from - Prefer small PRs in one area. - Review UI changes in a browser. Reading the source is not enough. -Planning documents and agent notes stay out of the repository. Commit the -change, its tests and a changeset; put the reasoning in the PR description. +Short Markdown proposals may update relevant maintained docs or use the PR +description. Keep task breakdowns and agent scratch notes out of the repo. +Code PRs include relevant tests and a changeset when required. ## Related diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5d880d..8daa579 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,22 @@ # Contributing to the FTW webapp -Sourceful develops this project. Fredrik owns FTW's product direction in -[the shared vision](https://github.com/srcfl/ftw/blob/master/VISION.md). External users submit -[issues](https://github.com/srcfl/ftw-webapp/issues) with bugs, needs and evidence. -We do not accept external pull requests, including documentation changes. -Acceptance of an issue does not invite an external implementation PR. - -Describe the expected result, what happened, the version and relevant -hardware. You do not need to write code. Keep credentials, keys and private -site data out of public reports. Sourceful selects and implements changes. - -Existing license rights and copyright attributions remain unchanged. -Sourceful implementation PRs should state the user need, coordinate overlap, -include relevant verification and follow the repository's development guide. +Sourceful maintains this repository. Fredrik owns FTW's direction in +[the shared vision](https://github.com/srcfl/ftw/blob/master/VISION.md). +External PRs are welcome, preferably based on an +[issue](https://github.com/srcfl/ftw-webapp/issues). Small fixes need no separate issue. + +Broad product or architecture ideas may start as short Markdown PRs in the +PR description or relevant maintained docs. Mark proposed behaviour as +proposed. Concrete fixes can include code and tests. Keep task breakdowns +and agent scratch notes out of the repository. + +Work is agentic first: give people and agents a clear problem, scope, +reproducible test steps and actual results. Check agent output before +submitting it. Test changed behaviour and review changed UI in a browser. +Hardware claims need relevant hardware evidence; distinguish simulation +from physical tests and state missing checks. Docs need no hardware tests. +Follow the repository guide and coordinate overlap with open PRs. + +Sourceful reviews and maintains changes. A contribution grants no merge, +release or deployment authority. Existing license rights and attribution +remain unchanged. See [FTW's contribution guide](https://github.com/srcfl/ftw/blob/master/CONTRIBUTING.md). diff --git a/README.md b/README.md index 342ae96..8ba5786 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,9 @@ clear outcomes for both people and authorized agents. The [roadmap](https://github.com/srcfl/ftw/blob/master/docs/roadmap.md) states acceptance evidence. Goals such as cloud MCP access are distinct from implemented protocol support. -Sourceful maintains the app. External users report needs and bugs through -[issues](https://github.com/srcfl/ftw-webapp/issues), not PRs. +Sourceful maintains the app. PRs are welcome, preferably based on +[issues](https://github.com/srcfl/ftw-webapp/issues). Share a short Markdown +proposal or a focused fix with relevant test evidence. See [CONTRIBUTING.md](CONTRIBUTING.md). ## The shape of it