Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# Contributing to the FTW website

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-web/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-web/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
Comment on lines +13 to +14

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restore the warning against publishing sensitive data

When contributors provide the newly requested reproducible steps, actual results, or hardware evidence, this revision removes the guide's only warning to keep credentials, keys, and private site data out of public reports. Contributors commonly satisfy evidence requests with logs or configuration, so retaining that redaction warning near these requirements would help prevent accidental disclosure.

Useful? React with 👍 / 👎.

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).
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ Explain mixed-equipment coordination, simple defaults, local control and
visible outcomes. Clearly distinguish implemented capabilities from goals
such as cloud MCP. Do not publish predicted savings as measured results.

Sourceful maintains the product; Fredrik owns its direction. External users
submit [issues](https://github.com/srcfl/ftw-web/issues), not PRs, including
copy corrections. See [CONTRIBUTING.md](CONTRIBUTING.md). Keep existing license
and historical attribution intact. Inspect rendered copy before publishing.
Sourceful maintains the product; Fredrik owns its direction. PRs are welcome,
preferably based on [issues](https://github.com/srcfl/ftw-web/issues). Share a
short Markdown proposal or a focused fix with relevant evidence. Work is
agentic first; see [CONTRIBUTING.md](CONTRIBUTING.md). Keep existing license
and attribution intact. Inspect rendered copy before publishing.

## Local dev

Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ <h2>New hardware should be a driver, not a fork.</h2>
<div class="community-intro">
<p class="section-kicker">The community edition</p>
<h2>Open source, maintained by Sourceful.</h2>
<p>Run FTW at home, study it, modify it and use it commercially under Apache-2.0. Sourceful Energy develops and maintains FTW. External users help through issues with bugs, needs and evidence. We do not accept external pull requests.</p>
<p>Run FTW at home, study it, modify it and use it commercially under Apache-2.0. Sourceful Energy develops and maintains FTW. Contributions are welcome: start with an issue, share a short Markdown proposal or send a focused PR with relevant test evidence.</p>
<div class="license-line"><span>Apache-2.0</span><span>Public roadmap</span><span>Community issues</span></div>
</div>
<div class="community-panels">
Expand All @@ -274,7 +274,7 @@ <h3>You operate what you run.</h3>
<article>
<span class="panel-tag">Contribute</span>
<h3>Make the shared system better.</h3>
<p>Report a device need, reproduce a hardware problem or suggest a clearer flow. Open an issue with what you want to achieve; Sourceful handles implementation, including documentation and drivers.</p>
<p>Report a need, share a Markdown proposal or send a tested fix. Prefer an issue as the starting point. Our agentic-first approach uses clear problems and reproducible results that people and agents can review. Hardware claims need hardware evidence.</p>
<div class="panel-links">
<a href="https://github.com/srcfl/ftw/blob/master/CONTRIBUTING.md">Contribution guide <span aria-hidden="true">↗</span></a>
<a href="https://github.com/srcfl/ftw/issues">Report an issue <span aria-hidden="true">↗</span></a>
Expand Down