From afd5612e17abeca9d41c8c0f71844613c1d09875 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ilkka=20Sepp=C3=A4l=C3=A4?= Date: Mon, 27 Jul 2015 20:52:00 +0300 Subject: [PATCH 1/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 753b500bb..f1522d25f 100644 --- a/README.md +++ b/README.md @@ -783,7 +783,7 @@ As for performance and scalability, pools can become bottlenecks, if all the poo # Versioning -Java-design-patterns project uses [semantic versioning](http://semver.org/) scheme. +Java-design-patterns project uses [semantic versioning](http://semver.org/) scheme. However, version numbers in this project do not signify binary releases (since we don't make any) but rather milestones achieved on the roadmap. In other words, version numbers are used only for project planning sake. From 3adffb62da865c887d8757d12214d98927f868cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ilkka=20Sepp=C3=A4l=C3=A4?= Date: Mon, 27 Jul 2015 21:00:30 +0300 Subject: [PATCH 2/2] Update README.md --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f1522d25f..cd100d7c6 100644 --- a/README.md +++ b/README.md @@ -754,20 +754,23 @@ As for performance and scalability, pools can become bottlenecks, if all the poo # How to contribute -**To add a new pattern** you need to do the following steps: +**To work on a new pattern** 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. -4. Add description of the pattern in README.md and link to the class diagram. +1. If there is no issue for the new pattern yet, raise new issue. Comment on the issue that you are working on it so that others don't start work on the same thing. +2. Fork the repository. +3. Implement the code changes in your fork. Remember to add sufficient comments documenting the implementation. Reference the issue id e.g. #52 in your commit messages. +4. Create a simple class diagram from your example code. +5. Add description of the pattern in README.md and link to the class diagram. +6. Create a pull request. + +**To work on one of the non-pattern issues** you need to do the following steps: + +1. Check that the issue has "help wanted" badge +2. Comment on the issue that you are working on it +3. Fork the repository. +4. Implement the code changes in your fork. Remember to add sufficient comments documenting the implementation. Reference the issue id e.g. #52 in your commit messages. 5. Create a pull request. -**To work on one of the raised issues** 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. Reference the issue id e.g. #52 in your commit messages. -3. Create a pull request. - **For creating/editing UML diagrams** you need [ObjectAid UML Explorer for Eclipse](http://www.objectaid.com/home). **For inspiration** check out the following sources: