Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup #18

Merged
merged 13 commits into from
Oct 26, 2022
10 changes: 10 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"overrides": [
{
"files": "*.md",
"options": {
"proseWrap": "always"
}
}
]
}
36 changes: 25 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@

Please ensure your pull request adheres to the following guidelines:

- Search previous suggestions before making a new one, as yours may be a duplicate.
- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.
- Search previous suggestions before making a new one, as yours may be a
duplicate.
- Make sure the list is useful before submitting. That implies it has enough
content and every item has a good succinct description.
- Make an individual pull request for each suggestion.
- Use [title-casing](https://capitalizemytitle.com/) (AP style).
- Use the following format: `[List Name](link)`
- Link additions should be added to the bottom of the relevant category, with the exception of date ordered categories.
- Link additions should be added to the bottom of the relevant category, with
the exception of date ordered categories.
- New categories or improvements to the existing categorization are welcome.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
Expand All @@ -27,23 +30,34 @@ Thank you for your suggestions!

## Creating your own awesome list

To create your own list, check out the [instructions](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
To create your own list, check out the
[instructions](https://github.com/sindresorhus/awesome/blob/master/create-list.md).

## Adding something to an awesome list

If you have something awesome to contribute to an awesome list, this is how you do it.
If you have something awesome to contribute to an awesome list, this is how you
do it.

You'll need a [GitHub account](https://github.com/join)!

1. Access the awesome list's GitHub page. For example: https://github.com/mbasso/awesome-wasm
1. Access the awesome list's GitHub page. For example:
https://github.com/mbasso/awesome-wasm
2. Click on the `README.md`.
3. Now click on the edit icon.
4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/).
5. Say why you're proposing the changes, and then click on "Propose file change".
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
4. You can start editing the text of the file in the in-browser editor. Make
sure you follow guidelines above. You can use
[GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/).
5. Say why you're proposing the changes, and then click on "Propose file
change".
6. Submit the
[pull request](https://help.github.com/articles/using-pull-requests/)!

## Updating your Pull Request

Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.
Sometimes, a maintainer of an awesome list will ask you to edit your Pull
Request before it is included. This is normally due to spelling errors or
because your PR didn't match the awesome-\* list guidelines.

[Here](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
[Here](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md)
is a write up on how to change a Pull Request, and the different ways you can do
that.
Loading