Home of delightful curated lists of free software, open science and information sources.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

4.3 KiB

A delightful checklist

Read What are delightful lists? if you are unfamiliar with the concept.

For any curated delightful list to be added to the top-level project, it must adhere to the criteria mentioned in on this page.

List quality

Important: You should strive to only include the best resources on your delightful lists!

After all this is about collecing the true gems 💎 of freedom not just any 'Hello World' projects or information pages with casual rants.

After you submit your candidate list, the maintainers will validate the criteria for inclusion, as well as gauge the quality of your list entries. We know that quality is subjective and we try to be as fair as possible here.

When there are quality issues with the list we'll start a discussion on our issue tracker and (try to) notify you. In case of a continued dispute, we may - with your consent - put out a poll on the fediverse using the @humanetech account. But no matter the outcome of that vote, the final choice of the maintainers is at all times the deciding factor.

Inclusion criteria

  • Your delightful list is set up as a git repository.

    • It does not matter where your list is hosted. Can be Gitlab, Gitea, Sourcehut, etc. But we prefer Codeberg as the location.
  • You repository is structured as follows:

    • Repository name is in small caps, words separated by dashed and starting with 'delightful', like so: delightful-<list-topic>.
    • Repository description is brief and starts with A curated list of delightful <list-topic> <...>.
    • The curated list is maintained on the main README.md markdown list of the repository.
  • See Creating a delightful list for requirements and options for structuring your README.md.

delightful badge

  • Your list must have the delightful badge with a link to this project. The badge location is:
    • Right after the title text, if you have a markdown header as title.
    • After the list logo, but before the 'Contents' section starts.

Badge markdown for PNG badge (note: there is also a SVG version):

[![delightful](https://codeberg.org/teaserbot-labs/delightful/media/branch/main/assets/delightful-badge.png)](https://codeberg.org/teaserbot-labs/delightful)

All criteria met?

Please check these criteria very well, in order to lower the burden of quality checks for maintainers as much possible.

If you are ready, you can place a request for inclusion to the top-level project. There are three options for to add your candidate list. From best to worst these are:

  1. [Best option] If you have an account on Codeberg, or want to create one, then you can fork this repository, make a change to the README.md and send us your Pull Request. In your PR:

    • The PR title is Add delightful-<list-topic>.
    • The PR description includes URL of the list and a short summary explaining why it should be added.
    • The README.md update in the appropriate format - a link to the README.md of your list (!) - followed by (preferably fitting a single line) a description. The entry placed under the desired category, and added in alphabetical (!) order to existing entries.
    • The delightful-contributors.md update, if you want to be attributed and are not yet on the list.
  2. Alternatively create an issue in our tracker, add the candidate label and provide the same info as is described in option 1.

  3. [Least best option] If you don't want to create a Codeberg account, then you could send a request via the Fediverse by sending a public toot (please do not DM for this!) to @humanetech@mastodon.social. See option one on what to include, and also add the #delightful hashtag.

    • Your request may be missed in the deluge of notications. In that case don't be disappointed, and just try again or create that Codeberg account and choose option 1 ;)

After inclusion

We welcome you, delightful contributor, and thank you for your help to make the world a tiny bit better together with us!