gaspersic/java-design-patterns
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ilkka Seppälä 2014-11-04 08:04:42 +02:00
parent e574d6aa49
commit ee931b0ecb
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -303,17 +303,19 @@ The difference is the intent of the patterns. While Proxy controls access to the
# How to contribute # How to contribute
For a new pattern to be added you need to do the following steps: **To add a new pattern** you need to do the following steps:
1. Fork the repository. 1. Fork the repository.
2. Implement the code changes in your fork. Remember to add sufficient comments documenting the implementation. 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. 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. 4. Add description of the pattern in README.md and link to the class diagram.
5. Create a pull request. 5. Create a pull request.
If you want to edit the existing UML diagrams I can easily add you as an editor to the corresponding GenMyModel-project. Just drop me an email mentioning the pattern you are editing. **To edit the existing UML diagrams** you need one of the following:
- [GenMyModel](http://genmymodel.com/)
- [ObjectAid UML Explorer for Eclipse](http://www.objectaid.com/home)
There is a good list of design patterns at [Wikipedia](http://en.wikipedia.org/wiki/Software_design_pattern). **For inspiration** there is a good list of design patterns at [Wikipedia](http://en.wikipedia.org/wiki/Software_design_pattern).