Contribution guide

Welcome, we are happy to see you here. We suggest you to read all guides before contributing.

Table of Contents

• Prerequisites
• Project Skeleton
• Setup for development
• Contribution

Prerequisites

You just need to be aware of using below things

• Node
• ExpressJs
• AJAX
• Mocha
• Chai
• Supertest

Project Skeleton

Ludo/
├─ public/
│  ├─ css/
│  ├─ js/
|  ├─ img/
│  └─ *.html
├─ src/
│  ├─ handlers/
│  ├─ models/
│  └─ lib/
├─ test/
│  ├─ libTest/
│  ├─ integration/
│  └─ unitTest/
├─ templates/
├─ logs/
│  └─  *.log
├─ .gitignore
├─ .eslintrc
├─ README.md
├─ .editorconfig
├─ package.json
├─ server.js
└─ pre-commit.sh

Setup for development

To contribute for this project you should follow this process:-

1. clone the repository https://github.com/STEP-tw/ludo-dvamps.git

2. run sh bin/setup.sh command on your terminal.

Contribution

After preparing development environment, select a story that you want to work on and assign it to yourself.

As a pair follow TDD, write tests to cover every line of code you added.

Home