remote/open-slopware
1
0
Fork 0
mirror of https://codeberg.org/small-hack/open-slopware.git synced 2026-05-29 21:27:01 +02:00
Code Issues Projects Releases Packages Wiki Activity
open-slopware/STYLE.md
jessebot a2bf727199 adds a permits LLM ingestion tag (#472) 
closes #345

Feel free to suggest improvements!

Reviewed-on: https://codeberg.org/small-hack/open-slopware/pulls/472
2026-04-26 12:32:38 +02:00

5.6 KiB
Raw Blame History

Style Guide

This is a guide for how to structure the markdown tables and headings of the main README.md of this repo. Please be sure to organize the categories alphabetically to save people time in finding things within the list.

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 (note that it is alphabetized by software name):

Name Last Untainted Version or Commit ID Tags and Evidence Alternative(s)
formallyCoolSoftware v2.0.0 or ab12345 Permissive AI policy (1)
AI Sponsored (1)		 coolSlopFreeProject
formallyOKSoftware v2.0.0 or ab12345 Permissive AI policy (1)
AI Sponsored (1)		 [alrightSlopFreeProject]

Evidence column: should contain one or more of the following tags (followed by up to 3 numbered evidence links in parentheses):

  • AI Functionality
  • Permissive AI policy
  • AI Code Reviews
  • AI sponsored
  • Gen AI 'Art'
  • AI Databroker Usage
  • AI In Issue Tracker
  • Permits LLM Ingestion

Don't know what the alternative or last known good version is? Use this badge in its place:

  • Request for Help

Here are all the badges for easy copying and pasting:

[![AI Functionality](./badges/ai-functionality-yellow.svg)](#ai-functionality)

[![Permissive AI policy](./badges/permissive-ai-policy-orange.svg)](#permissive-ai-policy)

[![AI Code Reviews](./badges/ai-code-reviews-purple.svg)](#ai-code-reviews)

[![AI sponsored](./badges/ai-sponsored-blue.svg)](#sponsored-by-ai)

[![Gen AI 'Art'](./badges/gen-ai-art-dark-yellow.svg)](#gen-ai-art)

[![AI Databroker Usage](./badges/ai-databroker-usage-pink.svg)](#ai-databroker-usage)

[![AI In Issue Tracker](./badges/ai-in-issue-tracker-teel.svg)](#ai-in-issue-tracker)

[![Permits LLM Ingestion](./badges/permits-llm-ingestion.svg)](#permits-llm-ingestion)

[![Request for Help](./badges/request-for-help.svg)](#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.