Commit 65e1c49b authored by Evren Kutar's avatar Evren Kutar

readme enhancement +

parent 8ad0f8e6
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
##Get Ready For Development ##Get Ready For Development
1. Get Repo `git clone git@github.com:zetaops/zaerp-ui.git` 1. Get Repo `git clone git@github.com:zetaops/zaerp-ui.git`
*if you are not familiar to git follow these guides:* *if you are not familiar with git follow these guides:*
- https://git-scm.com/doc - https://git-scm.com/doc
- https://try.github.io/levels/1/challenges/1 - https://try.github.io/levels/1/challenges/1
...@@ -29,6 +29,13 @@ Using extreme programming techniques, we demand you to follow this cycle of deve ...@@ -29,6 +29,13 @@ Using extreme programming techniques, we demand you to follow this cycle of deve
![extreme programming cycle] ![extreme programming cycle]
(https://upload.wikimedia.org/wikipedia/commons/thumb/8/84/Extreme_Programming.svg/640px-Extreme_Programming.svg.png?1433328761062) (https://upload.wikimedia.org/wikipedia/commons/thumb/8/84/Extreme_Programming.svg/640px-Extreme_Programming.svg.png?1433328761062)
Other then that technique, follow these steps when you code:
- before you code anything create a branch with name related to the given task (e.g: search_func)
- `git checkout <branch>`
- `git pull --rebase`
- after you create the branch for given task and rebase master, now you can write down your code
##Testing ##Testing
*_test.js files are unit test files coded in Jasmine. to run tests run this command: *_test.js files are unit test files coded in Jasmine. to run tests run this command:
...@@ -48,11 +55,15 @@ To run e2e tests, which is located under e2e-tests folder, we use protractor. Ru ...@@ -48,11 +55,15 @@ To run e2e tests, which is located under e2e-tests folder, we use protractor. Ru
- Commit by little changes - Commit by little changes
###Code: ###Code:
- DRY - don't repeat yourself (no idea? read this: https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
- Use comments to explain what your code does - Use comments to explain what your code does
- Code clean and neat - Code clean and neat
- Name variables, objects with expository words - Name variables, objects with expository words
###Test: ###Test:
- Follow this guide to write effective test cases: http://www.softwaretestinghelp.com/how-to-write-effective-test-cases-test-cases-procedures-and-definitions/
- Tests must be cover as much as possible of your code.
##Must Reads: ##Must Reads:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment