Commit graph

3 commits

Author SHA1 Message Date
Cynthia Fox
44b257354f
CONTRIBUTING.md: Add links to upstream (#157)
The Awesome project provides a couple of requirements for lists that we
should more easily make available to contributors.

Also, inform contributors of the linter.
2023-05-29 11:35:50 -04:00
Cynthia Fox
01f757a208
CONTRIBUTING.md: Tweak grammar for readability (#128)
* CONTRIBUTING.md: Request factual descriptions

In the past, we've allowed rather non-descript summary descriptions for
projects (see the `nixpkgs-hammering` entry). In order to better comply
with the official comment guidelines laid out in the parent `awesome`
project and better serve those browsing the list, update the
contributing guidelines to specify that descriptions should also be
persuasive and factual, while providing an example format.

Additionally, fix the grammar/verb-tense for the alphabetical
requirement.

* CONTRIBUTING.md: Reduce guidance for simplicity

Asking for an agile user-story is a little much... but having a
"descriptive description" is redundant, so just keep it short and
simple.

* CONTRIBUTING.md: Adjust phrasing

Rephrase the category modification guideline to match the other imperative guidelines
2023-05-29 11:32:38 -04:00
zimbatm
94443ab7a2
Rename contributing.md to CONTRIBUTING.md 2019-05-16 10:10:50 +01:00
Renamed from contributing.md (Browse further)