-
Notifications
You must be signed in to change notification settings - Fork 3
Contribute
Michael Held edited this page Nov 22, 2020
·
22 revisions
-
Write a code pattern
- Give a corresponding name to your main directory.
- Give a corresponding name to your Classes.
- Write comments if need it
-
Make a UML diagram.
- Best way to make UML diagram use Figma. It's free
- The UML diagram must match the code
- Elements of the UML diagram you find here
-
Add some explanation
-
Where should I put my pattern?
/patterns/%GroupOfPattern%/%NameofPattern%/%NameOfYourPattern%/ /patterns/%GroupOfPattern%/%NameofPattern%/%NameOfYourPattern%/README.md
TODO: make a picture of the directory scheme.
-
How to add a picture to README.md
- Write the name of a picture. Example: (picture: 1) or (picture: Class A)
- Name picture in README.md and in Figma must be same
- Write a link on the Figma image
-
Create a branch
- Name of the branch must be: %yourGitNickname%NameOfPattern%. Example: held-m-AbstractFactory