Skip to content

contributing.md

Latest commit

 

History

History
51 lines (31 loc) · 3.29 KB

contributing.md

File metadata and controls

51 lines (31 loc) · 3.29 KB

Contribution Guidelines

This project is released with a Contributor Code of Conduct. By engaging with this project you agree to abide by its terms.

Add an entry to this list

For an entry to be added to this list, the entry must be:

  • awesome;
  • seen as awesome by two or more community members (as evidenced by comments on your PR); and
  • directly relevant the Autonity project.

To add an entry to the list, you should:

  • submit a PR with your entry added to readme.md under what you believe to be the appropriate category;
  • using correctly formatted markdown, like - [<entry description>](<entry url>) (a dash, a single space and the markdown link); and
  • include a few sentences in your PR explaining why you think the resource is awesome and relevant to this list.

Propose that an existing entry is removed

Not every entry is timelessly awesome. Perhaps an entry loses its awesomeness by becoming out-of-date, or perhaps an entry duplicates the essential information of a subsequently added, more awesome entry. Whatever the reason, if you think there's a good reason to remove an entry, you should:

  • submit a PR with the entry removed from readme.md; and
  • include a few sentences in your PR explaining why the entry is no longer awesome and should be removed.

The entry will be removed if:

  • five or more community members (as evidenced by comments on your PR) agree that the entry should be removed.

Note: there is no stigma attached to the removal of an entry; it was once awesome so will forever be an exceptional resource on the internet :)

Reorganise entries

Entries are organised under top-level categories (i.e., lines prefixed with a single #). Unless there proves to be a compelling reason to add sub-categories, there will be only a single, top-level categorisation of entries. (A compelling reason could be something like: categories under a top-level category make-up a natural and exhaustive taxonomy.)

Categorisation is rarely fixed forever. As entries grow, the organisation of the entries will need to change from time-to-time. Some reorganisation events are:

  • add a new category;
  • rename an existing category to something more accurate;
  • break up an existing category into two or more more detailed categories (or, if there's good reason, sub-categories);
  • move an entry under a more appropriate category;

If you believe entries should be reorganised, you should:

  • submit a PR with your proposed reoganisation;
  • make sure your PR contains only a single reorganisation event per commit (and consistently describe the event in your commit messages);
  • include a few sentences in your PR explaining why you think your reorganisation proposal improves the current state of the list.

Guidelines for authors of entries

If you are authoring the awesome entry you want added to this list, please consider publishing your content on ipfs. This is easy to do and Autonity community members will pin all ifps links in this list so that it is always available.