awesome/microservices
1
0
Fork 0
mirror of https://github.com/mfornos/awesome-microservices.git synced 2024-11-20 11:16:15 -05:00
Code Activity

Added Contribution Guidelines document.

Browse source
This commit is contained in:
mfornos 2015-10-14 21:11:24 +02:00
parent 6273f8dd31
commit 65629edd8c
2 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,16 @@
# Contribution Guidelines
## Adding to this list
Please ensure your pull request adheres to the following guidelines:
- Make an individual pull request for each suggestion.
- Use the following format: `[Resource Name](link) - Short description.`
- Don't repeat the resource name in the description.
- Link additions should be added in alphabetical order to the relevant category.
- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
- Check your spelling and grammar.
- New categories or improvements to the existing categorization are welcome.
- The pull request and commit should have a useful title.
Thank you for your suggestions!

8
README.md
View file

@ -340,8 +340,8 @@ of the testing and deployment process.
- [API Blueprint](https://apiblueprint.org/) - Tools for your whole API lifecycle. Use it to discuss your API with others. Generate documentation automatically. Or a test suite. Or even some code. - [API Blueprint](https://apiblueprint.org/) - Tools for your whole API lifecycle. Use it to discuss your API with others. Generate documentation automatically. Or a test suite. Or even some code.
- [Apidoc](https://github.com/mbryzek/apidoc) - Beautiful documentation for REST services. - [Apidoc](https://github.com/mbryzek/apidoc) - Beautiful documentation for REST services.
- [RAML](http://raml.org/) - RESTful API Modeling Language, a simple and succinct way of describing practically-RESTful APIs. - [RAML](http://raml.org/) - RESTful API Modeling Language, a simple and succinct way of describing practically-RESTful APIs.
- [Swagger](http://swagger.io/) - A simple yet powerful representation of your RESTful API.
- [Spring REST Docs](http://projects.spring.io/spring-restdocs/) - Document RESTful services by combining hand-written documentation with auto-generated snippets produced with Spring MVC Test. - [Spring REST Docs](http://projects.spring.io/spring-restdocs/) - Document RESTful services by combining hand-written documentation with auto-generated snippets produced with Spring MVC Test.
- [Swagger](http://swagger.io/) - A simple yet powerful representation of your RESTful API.
## Testing ## Testing
@ -474,11 +474,11 @@ a strategic modeling approach. :small_orange_diamond:<sup>PDF</sup>
## Contributing ## Contributing
To contribute, please, [open an issue](https://github.com/mfornos/awesome-microservices/issues) or [create a pull request](https://github.com/mfornos/awesome-microservices/pulls). Please, read the [Contribution Guidelines](https://github.com/mfornos/awesome-microservices/blob/master/CONTRIBUTING.md) before submitting your suggestion.
:star2: Additions, suggestions, and structural amendments are welcome. Feel free to [open an issue](https://github.com/mfornos/awesome-microservices/issues) or [create a pull request](https://github.com/mfornos/awesome-microservices/pulls) with your additions.
Thank you! :star2: Thank you!
## Acknowledgments ## Acknowledgments