-
Notifications
You must be signed in to change notification settings - Fork 1
docs: welcome issue-led PRs and Markdown proposals #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| 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). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 👍 / 👎.