/3-musketeers

🤺 RDD, CDD, TDD

Primary LanguageJavaScript

3 Musketeers

RDD, CDD and TDD

3-musketeers

Table of Contents

🐣 Introduction

Being a Good Programmer Isn't Just About Writing Code.

It's also writing documentations, comments and unit tests.

🎯 Objectives

  1. write the README.md and missing comments (use JSDoc format) for the library cash
  2. write the Unit Tests for the library starwars

👩‍💻 Just tell me what to do

  1. Fork the project via `github`

    fork

  2. Clone your forked repository project `https://github.com/YOUR_USERNAME/3-musketeers` 
    ❯ cd /path/to/workspace
❯ git clone git@github.com:YOUR_USERNAME/3-musketeers.git
  3. Do things
  4. Commit and push your different modifications 
    ❯ cd /path/to/workspace/3-musketeers
❯ git add -A && git commit -m "docs(readme): add usage section"
❯ git push origin master

Note:

🏃‍♀️ Steps to do

cash: RDD and CDD

Understand first the library features

❯ cd /path/to/workspace/3-musketeers/cash
❯ npm i
❯ node bin/index.js

# chech what's going on
# ...
  1. Complete the cash/README.md file with a complete description of installation, usage... of the library
  2. Add block commments (use JSDoc format) for the file cash/bin/cash.js

starwars: TDD

Understand first the library features

❯ cd /path/to/workspace/3-musketeers/starwars
❯ npm i
❯ node sandbox.js

# chech what's going on
# ...
  1. Run unit tests with npm run test
  2. Complete the unit tests (with Jest as testing framework) file starwars/src/index.test.js to cover at least 80%

About Jest

  • Getting started with Jest
  • Jest uses matchers to let you test values in different ways.
  • When you're writing tests, you often need to check that values meet certain conditions. expect gives you access to a number of matchers that let you validate different things.

🛣️ Related course

Licence

Uncopyrighted