mirror of
https://github.com/tmrts/go-patterns.git
synced 2024-11-25 22:46:05 +03:00
Update README and Contribution Guidelines
This commit is contained in:
parent
7680a25f35
commit
6257c096bb
7
CONTRIBUTING.md
Normal file
7
CONTRIBUTING.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# Contribution Guidelines
|
||||||
|
|
||||||
|
Please ensure your pull request adheres to the following guidelines:
|
||||||
|
|
||||||
|
- Make an individual pull request for each suggestion.
|
||||||
|
- Chose corresponding section of patterns for your suggestion.
|
||||||
|
- List, after your addition, should be alphabetically.
|
24
README.md
24
README.md
@ -1,7 +1,11 @@
|
|||||||
# awesome-go-patterns
|
# Go Patterns [![Awesome Widget]][Awesome] [![Travis Widget]][Travis] [![License Widget]][License]
|
||||||
A collection of Go design patterns/idioms
|
[Awesome Widget]: https://img.shields.io/badge/awesome-%E2%9C%93-ff69b4.svg?style=flat-square
|
||||||
|
[Awesome]: https://github.com/sindresorhus/awesome
|
||||||
Current Patterns:
|
[Travis Widget]: https://img.shields.io/travis/tmrts/awesome-google-cloud.svg?style=flat-square
|
||||||
|
[Travis]: http://travis-ci.org/tmrts/go-patterns
|
||||||
|
[License Widget]: https://img.shields.io/badge/license-Creative%20Commons%204.0-E91E63.svg?style=flat-square
|
||||||
|
[License]: http://creativecommons.org/licenses/by/4.0/
|
||||||
|
A curated collection of common patterns & idioms for Go.
|
||||||
|
|
||||||
__Creational Patterns__:
|
__Creational Patterns__:
|
||||||
|
|
||||||
@ -48,3 +52,15 @@ __Behavioral Patterns__:
|
|||||||
| [strategy](strategy.go) | selectable operations over the same data |
|
| [strategy](strategy.go) | selectable operations over the same data |
|
||||||
| [template](template.go) | an object imposes a structure but takes pluggable components |
|
| [template](template.go) | an object imposes a structure but takes pluggable components |
|
||||||
| [visitor](visitor.go) | invoke a callback for all items of a collection |
|
| [visitor](visitor.go) | invoke a callback for all items of a collection |
|
||||||
|
|
||||||
|
__Concurrency Patterns__:
|
||||||
|
|
||||||
|
| Pattern | Description |
|
||||||
|
|:-------:| ----------- |
|
||||||
|
| [semaphore](semaphore.go) | data type for controlling access, to a common resource|
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
[![Creative Commons License](http://i.creativecommons.org/l/by/4.0/88x31.png)](http://creativecommons.org/licenses/by/4.0/)
|
||||||
|
|
||||||
|
This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
|
||||||
|
Loading…
Reference in New Issue
Block a user