awesome-nix/CONTRIBUTING.md

# 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.
- Any added projects should be at least 30 days old.
- 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.

See also the upstream Awesome project's [contribution guidelines](https://github.com/sindresorhus/awesome/blob/main/contributing.md) and [manifesto/requirements](https://github.com/sindresorhus/awesome/blob/main/awesome.md). Some of the more basic entry formatting requirements are checked via a [awesome-lint](https://github.com/sindresorhus/awesome-lint) GitHub Action; run it locally first if you can!

Thanks for contributing!
Create contributing.md 2019-05-15 15:35:47 +00:00			`# 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.`
CONTRIBUTING.md: Add 30 day requirement (#173) Add an explicit age requirement for projects to ensure they're both truly awesome and maintained. Closes #96 2023-05-31 23:36:00 +00:00			`- Any added projects should be at least 30 days old.`
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 15:32:38 +00:00			`- Keep descriptions short and simple.`
			`- Add new categories or improve existing categories if possible -- it's welcome!`
Create contributing.md 2019-05-15 15:35:47 +00:00			`- Double check your spelling and grammar! 😁`
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 15:32:38 +00:00			`- Keep entries sorted alphabetically by title.`
Create contributing.md 2019-05-15 15:35:47 +00:00
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 15:35:50 +00:00			`See also the upstream Awesome project's [contribution guidelines](https://github.com/sindresorhus/awesome/blob/main/contributing.md) and [manifesto/requirements](https://github.com/sindresorhus/awesome/blob/main/awesome.md). Some of the more basic entry formatting requirements are checked via a [awesome-lint](https://github.com/sindresorhus/awesome-lint) GitHub Action; run it locally first if you can!`

Create contributing.md 2019-05-15 15:35:47 +00:00			`Thanks for contributing!`