46e3440a11
# Major changes - adds a specific style guide to point to and iterate on - closes #139 - markdown tables will now have special tags (using badges) to be used in the evidence column, instead of the aforementioned "severities" concept" - you can read the discussion in this PR as to why we decided against a severity column. - closes #146 - markdown tables will have a "Last Untainted Version/Commit ID" column - closes #113 - markdown tables would drop the notes section (in favor of the above columns and below point) - markdown table now have "alternative" as last column instead of second. - makes official docs on how to make an alternatives section for a given category - updaetes python libraries as the first category to get an overhaul to the new style guide ## Minor Changes - fix some grammar stuff (capitalization, periods, weird wording) - move GoToSocial into the correct alphabetical order in the bottom alternatives links section Co-authored-by: @axaloteDev Co-authored-by: @tjk Co-authored-by: @PeculiarDemon Co-authored-by: @cloudymax Co-authored-by: @micdan5 Co-authored-by: @Pixelo789 Reviewed-on: https://codeberg.org/small-hack/open-slopware/pulls/179 Reviewed-by: Max <cloudymax@noreply.codeberg.org> Co-authored-by: jessebot <jessebot@linux.com> Co-committed-by: jessebot <jessebot@linux.com>
4.5 KiB
Style Guide
This is a guide for how to structure the markdown tables and headings of the main README.md of this repo.
Tainted Software
Be sure to put things in the correct category and always update the above TOC (table of contents), so people can easily find your entries. The alternatives heading for each category is only necessary if all items in the category share the same alternatives. More on that below.
Category
Make sure to format your table like below:
| Name | Last Untainted Version or Commit ID | Tags and Evidence | Alternative(s) |
|---|---|---|---|
| formallyCoolSoftware | v2.0.0 or ab12345 |
 (1) (1) |
coolSlopFreeProject |
Evidence column: should contain one or more of the following tags (followed by up to 3 numbered evidence links in parentheses):
Don't know what the alternative or last known good version is? Use this badge in its place:
Here are all the badges for easy copying and pasting:
[](https://codeberg.org/small-hack/open-slopware#vibecoded)
[](https://codeberg.org/small-hack/open-slopware#ai-functionality)
[](https://codeberg.org/small-hack/open-slopware#permissive-ai-policy)
[](https://codeberg.org/small-hack/open-slopware#ai-code-reviews)
[](https://codeberg.org/small-hack/open-slopware#sponsored-by-ai)
[](https://codeberg.org/small-hack/open-slopware#request-for-help)
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.
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.
Screenshots are allowed but must be a last resort for something that cannot be linked. We'd prefer archive links in all other instances.
The above "Alternative(s)" column is for software that has a 1:1 parity or is a very similar alternative specific to the piece of software at hand. If the category or section is filled with the same alternative list (for instance, how it is in the terminal emulators section), you can remove the alternatives column. Instead, you can add a note below the table with all the alternatives, like this:
Note
Category Alternatives
If there are a lot of alternatives for a section, include the alternatives in a note like this.
- alternativeSoftware: This can be a short description and link to anti-AI policies.
- coolSlopFreeProject: This can be a short description and link to anti-AI policies.