Mirrors/awesome-nix
2
0
Fork 0
mirror of https://github.com/nix-community/awesome-nix synced 2024-11-10 07:44:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
awesome-nix/CONTRIBUTING.md
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

667 B
Raw Blame History

Contributing Guidelines

Make sure your pull request follows these guidelines:

  • Search through the previous pull requests before making a new one! 🙏
  • Make sure you've personally used or benefited from the suggested resource.
  • Make an individual pull request for each suggestion.
  • Use the following format: [Resource Title](url) — description.
  • Expand on why the resource is useful in your pull request if needed.
  • Keep descriptions short and simple.
  • Add new categories or improve existing categories if possible -- it's welcome!
  • Double check your spelling and grammar! 😁
  • Keep entries sorted alphabetically by title.

Thanks for contributing!