From 25469c210cf6015a0b0e59c47e2567ad5b77ca1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ilkka=20Sepp=C3=A4l=C3=A4?= Date: Sun, 7 Sep 2014 15:40:21 +0300 Subject: [PATCH] Added "How to contribute" instructions. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 4712d41d4..87e917589 100644 --- a/README.md +++ b/README.md @@ -254,3 +254,16 @@ In Template Method the algorithm is chosen at compile time via inheritance. With **Q: What is the difference between Proxy and Decorator patterns?** The difference is the intent of the patterns. While Proxy controls access to the object Decorator is used to add responsibilities to the object. + + + +# How to contribute + +For a new pattern to be added you need to do the following steps: +1. Fork the repository. +2. Implement the code changes in your fork. Remember to add sufficient comments documenting the implementation. +3. Create a simple class diagram from your example code. I've used [GenMyModel](https://www.genmymodel.com/) and its "Export as JPEG" feature. +4. Add description of the pattern in README.md and link to the class diagram. +5. Create a pull request. + +