mirror of
https://codeberg.org/small-hack/open-slopware.git
synced 2026-08-27 16:34:05 +02:00
Update the Style Guide (#1293)
### Description of Changes - Make all breaks be `<br />` - Add a whitespace before and after `<br />` (see https://codeberg.org/ethical-foss/open-slopware/pulls/1290#issuecomment-21570149) and request it - Add more example evidence links - Add an example for a project were Last Untainted Version/Commit ID is not yet applicable Reviewed-on: https://codeberg.org/ethical-foss/open-slopware/pulls/1293 Reviewed-by: Ethical FOSS admin <ethical-foss-admin@noreply.codeberg.org>
This commit is contained in:
parent
ead9bcddeb
commit
28f2ab46b3
1 changed files with 6 additions and 5 deletions
11
STYLE.md
11
STYLE.md
|
|
@ -14,16 +14,17 @@ Be sure to put things in the correct category and always update the above TOC (t
|
|||
|
||||
Make sure to format your table like below (note that it is alphabetized by software name):
|
||||
|
||||
| Name | Last Untainted <br />Version/Commit ID | Evidence | Alternative(s) |
|
||||
| Name | Last Untainted <br /> Version/Commit ID | Evidence | Alternative(s) |
|
||||
|---|:---:|---|---|
|
||||
| [formallyCoolSoftware](https://linktocoolsoftware.tld) | [`v1.0.0`](linktolastgoodcommitid.tld/releases/v1.0.0)<br/>[`ab12345`](linktolastgoodcommitid.tld/commit/ab12345) | [](https://codeberg.org/ethical-foss/open-slopware#ai-functionality) ([1](https://docs.linktocoolsoftware.tld/ai-assistant))<br/>[](#vibecoded) ([1](https://link-to-software-blog.tld/how-i-vibecoded-the-app)) <br/> [](#permissive-ai-policy) ([1](https://linktocoolsoftware.tld/branch/main/AGENTS.md))<br/> [](https://codeberg.org/ethical-foss/open-slopware#ai-code-reviews) ([1](https://linktocoolsoftware.tld/branch/main/AGENTS.md))<br/> [](https://codeberg.org/ethical-foss/open-slopware#gen-ai-art) ([1](https://linktocoolsoftware.tld/ai_logo.jpg))<br/> [](https://codeberg.org/ethical-foss/open-slopware#ai-databroker-usage) ([1](https://linktocoolsoftware.tld/privacypolicy)) <br/>  ([1](https://linktocoolsoftware.tld/branch/main/README.md)) <br/> [](https://codeberg.org/ethical-foss/open-slopware#ai-in-issue-tracker) ([1](http://linktocoolsoftware.tld/issues/123))<br/> [](https://codeberg.org/ethical-foss/open-slopware#condones-llm-ingestion) ([1](https://linktocoolsoftware.tld/branch/main/ai_policy.md)) | [coolSlopFreeProject] |
|
||||
| [formallyOKSoftware](https://linktofinesoftware.tld) | [`v2.0.0`](linktolastgoodversion.tld/v2.0.0) | [](#permissive-ai-policy) ([1](https://linktocoolsoftware.tld/branch/main/AGENTS.md))<br/>  ([1](https://linktocoolsoftware.tld/branch/main/README.md))| [alrightSlopFreeProject] <br/> [amazingSlopFreeProject] [](#anti-ai-policy) ([1](https://link-to-anti-ai-evidence.tld)) |
|
||||
| [formallyCoolSoftware](https://linktocoolsoftware.tld) | [`v1.0.0`](linktolastgoodcommitid.tld/releases/v1.0.0) <br /> [`ab12345`](linktolastgoodcommitid.tld/commit/ab12345) | [](https://codeberg.org/ethical-foss/open-slopware#ai-functionality) ([1](https://docs.linktocoolsoftware.tld/ai-assistant)) <br /> [](#vibecoded) ([1](https://link-to-software-blog.tld/how-i-vibecoded-the-app), [2](https://libktovibecodedpr.tld/12345)) <br /> [](#permissive-ai-policy) ([1](https://linktocoolsoftware.tld/branch/main/AGENTS.md)) <br /> [](https://codeberg.org/ethical-foss/open-slopware#ai-code-reviews) ([1](https://linktocoolsoftware.tld/branch/main/AGENTS.md)) <br /> [](https://codeberg.org/ethical-foss/open-slopware#gen-ai-art) ([1](https://linktocoolsoftware.tld/ai_logo.jpg), [2](https://linktocoolsoftware.tld/ai_asset.jpg), [3](https://linktocoolsoftware.tld/ai_banner.jpg)) <br /> [](https://codeberg.org/ethical-foss/open-slopware#ai-databroker-usage) ([1](https://linktocoolsoftware.tld/privacypolicy)) <br />  ([1](https://linktocoolsoftware.tld/branch/main/README.md)) <br /> [](https://codeberg.org/ethical-foss/open-slopware#ai-in-issue-tracker) ([1](http://linktocoolsoftware.tld/issues/123)) <br /> [](https://codeberg.org/ethical-foss/open-slopware#condones-llm-ingestion) ([1](https://linktocoolsoftware.tld/branch/main/ai_policy.md)) | [coolSlopFreeProject] |
|
||||
| [formallyOKSoftware](https://linktofinesoftware.tld) | [`v2.0.0`](linktolastgoodversion.tld/v2.0.0) | [](#permissive-ai-policy) ([1](https://linktocoolsoftware.tld/branch/main/AGENTS.md)) <br />  ([1](https://linktocoolsoftware.tld/branch/main/README.md)) | [alrightSlopFreeProject] <br /> [amazingSlopFreeProject] [](#anti-ai-policy) ([1](https://link-to-anti-ai-evidence.tld)) |
|
||||
| [veryCoolSoftware](https://linktoverycoolsoftware.tld) | Not yet applicable |  ([1](https://linktocoolsoftware.tld/branch/main/README.md)) | [](#request-for-help) |
|
||||
|
||||
**Name column**: should be the name of software linked to their git repo (or other software forge if they don't use git).
|
||||
|
||||
**Last Untainted Version/Commit**: should be the last commit before AI started being used in the repo. You can provide both the version and a commit hash, but if you can only provide one, please prefer using the version. (Reminder: This is meant for forking only, as running old software comes with security risks.) If the project is [](https://codeberg.org/ethical-foss/open-slopware##vibecoded), you can just use the word "None" for the Last Untainted Version/Commit. You must provide something (even "None" if Vibecoded) *either* for this column, or for the alternatives column - unless there is already an "Alternatives" note. See also: [tips for finding the last untainted commit](https://codeberg.org/ethical-foss/open-slopware/issues/1116).
|
||||
|
||||
**Evidence column**: should contain one or more of the following tags (followed by *up to 3* numbered evidence links in parentheses):
|
||||
**Evidence column**: should contain one or more of the following tags (followed by _up to 3_ numbered evidence links in parentheses separated by a comma followed by a whitespace):
|
||||
|
||||
- [](https://codeberg.org/ethical-foss/open-slopware#ai-functionality)
|
||||
- [](https://codeberg.org/ethical-foss/open-slopware##vibecoded) (keep in mind this is more severe than permissive AI policy)
|
||||
|
|
@ -99,7 +100,7 @@ Here are all the badges for easy copying and pasting:
|
|||
|
||||
> [!important]
|
||||
>
|
||||
> If a project has multiple tags, please be sure to add a break (`<br />`) in between each one, so that the column extends vertically rather than horizontally. This keeps the table visually consistent and easier to read at a glance.
|
||||
> If a project has multiple tags, please be sure to add a break (`<br />`), with a whitespace before and after, in between each one, so that the column extends vertically rather than horizontally. This keeps the table visually consistent and easier to read at a glance.
|
||||
|
||||
Please do not submit GitHub screenshots of "A user you have blocked has previously contributed to this repository". Please instead link directly to the commit hash(es) where this has taken place.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue