Skip to content

Commit c3da64c

Browse files
committed
Merge branch 'master' of https://github.com/iluwatar/java-design-patterns into HalfSyncHalfAsync
2 parents f778b2c + 3adffb6 commit c3da64c

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -754,19 +754,22 @@ As for performance and scalability, pools can become bottlenecks, if all the poo
754754

755755
# How to contribute
756756

757-
**To add a new pattern** you need to do the following steps:
757+
**To work on a new pattern** you need to do the following steps:
758758

759-
1. Fork the repository.
760-
2. Implement the code changes in your fork. Remember to add sufficient comments documenting the implementation.
761-
3. Create a simple class diagram from your example code.
762-
4. Add description of the pattern in README.md and link to the class diagram.
763-
5. Create a pull request.
759+
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.
760+
2. Fork the repository.
761+
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.
762+
4. Create a simple class diagram from your example code.
763+
5. Add description of the pattern in README.md and link to the class diagram.
764+
6. Create a pull request.
764765

765-
**To work on one of the raised issues** you need to do the following steps:
766+
**To work on one of the non-pattern issues** you need to do the following steps:
766767

767-
1. Fork the repository.
768-
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.
769-
3. Create a pull request.
768+
1. Check that the issue has "help wanted" badge
769+
2. Comment on the issue that you are working on it
770+
3. Fork the repository.
771+
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.
772+
5. Create a pull request.
770773

771774
**For creating/editing UML diagrams** you need [ObjectAid UML Explorer for Eclipse](http://www.objectaid.com/home).
772775

@@ -783,7 +786,7 @@ As for performance and scalability, pools can become bottlenecks, if all the poo
783786

784787
# Versioning
785788

786-
Java-design-patterns project uses [semantic versioning](http://semver.org/) scheme.
789+
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.
787790

788791

789792

0 commit comments

Comments
 (0)