Welcome, We are happy to see you here. We request you to read all the guidelines before contributing.

For styling guide click here

• Prerequisites
• Project Skeleton
• Setup for development
• Contribution

You just need to be aware of using below things

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

battleship/
├─ public/
│  ├─ css/
│  ├─ js/
│  ├─ assets/
│  └─ *.html
├─ src/
│  ├─ handlers/
│  └─ models/
├─ test/
│  ├─ helpers/
│  ├─ integration/
│  ├─ unit/
│  └─ functional/
├─ templates/
├─ logs/
│  └─  *.log
├─ .gitignore
├─ .eslintrc
├─ README.md
├─ .editorconfig
├─ package.json
└─ pre-commit.sh

To contribute for this project you need to do the following things.

1. clone the repository

> git clone https://github.com/STEP-tw/battleship-phoenix.git

2. Create a softlink to pre-commit hook file from hooks folder

 > ln -s ./pre-commit.sh .git/hooks/pre-commit

3. Install dependencies

> npm install

After preparing development environment , select a issue 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.