mirror of
https://github.com/marmelab/awesome-rest.git
synced 2026-05-01 20:20:10 -07:00
96a7c760d6
Clarified guidelines regarding REST API submissions.
29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
# Contribution Guidelines
|
|
|
|
Please ensure your pull request adheres to the following guidelines:
|
|
|
|
- Do not add your REST API to the list. This is not a registry of all possible REST APIs, but a list of reources and tools to build and use REST APIs effectively
|
|
- Read [the awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
|
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
|
- Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description.
|
|
- A link back to this list from yours, so users can discover more lists, would be appreciated.
|
|
- Make an individual pull request for each suggestion.
|
|
- Titles should be capitalized.
|
|
- Use the following format: `[List Name](link)`
|
|
- If you have a comment about the link, add it after a dash, start it with a capital letter, and end it with a full stop. Avoid starting your comment with an article like "A", "The".
|
|
- Link additions should be added to the bottom of the relevant category.
|
|
- 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.
|
|
- The pull request and commit should have a useful title.
|
|
|
|
Link format:
|
|
|
|
```
|
|
[Awesome resource name](resource link) - Performant REST client library by the famous John Doe.
|
|
^ ^ ^
|
|
dash capital letter, no article Full stop
|
|
```
|
|
|
|
Thank you for your suggestions!
|