mirror of
https://github.com/marmelab/awesome-rest.git
synced 2026-05-02 04:30:05 -07:00
bb208ce26e
Added a pull request template with guidelines for contributions.
31 lines
1.8 KiB
Markdown
31 lines
1.8 KiB
Markdown
**Do not add your API**. This registry helps developers discover tools and good practices for building and consuming REST APIs. It is not a copllection of public facing APIs.
|
|
|
|
**Do not add links to young tools**. This repository isn't a way to boost your Product Hunt visibility. If you launched a new tool, wait before it proves that it's widely useful before proposing it.
|
|
|
|
Any PR disregarding these rules will be closed.
|
|
|
|
If you have a genuine tool or resource to propose, please ensure your pull request adheres to the following guidelines:
|
|
|
|
- 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.
|
|
- 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
|
|
```
|
|
|
|
|