RDD, CDD and TDD
Table of Contents generated with DocToc
Coding is not only to write code.
The library cash that we need to
- write the README.md
- write missing comments with JSDoc
The library bitcoin that we need to
- write Unit Tests (with Jest as testing framework)
- Fork the project via
github
- Clone your forked repository project
https://github.com/YOUR_USERNAME/3-musketeers
❯ cd /path/to/workspace
❯ git clone [email protected]:YOUR_USERNAME/3-musketeers.git
- complete the cash/README.md file with a complete description of installation, usage... of the library
- add JSDOC function blocks for the 3 files cash/bin/cash.js, cash/bin/helpers.js and cash/bin/index.js
Execute unit test with npm run test
or yarn run test
-
write the unit tests bitcoin/tests/convert.js to cover 80%
-
commit your different modifications:
❯ cd /path/to/workspace/3-musketeers
❯ git add -A && git commit -m "docs(readme): describe how to use cash"
(why following a commit message convention?)
- Don't forget to push before the end of the workshop
❯ git push origin master