Skip to content

Commit 834162e

Browse files
committed
📚 update dev guide
1 parent e87ef8d commit 834162e

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Fork [moban](https://github.com/moremoban/moban) by clicking "Fork".
88
4. `source venv/bin/activate`
99
5. `git clone https://github.com/YOUR_USERNAME/moban.git`
1010
6. `cd moban`
11-
7. `pip3 install -e .`
11+
7. `pip install -r requirements.txt`
1212
8. `git remote add upstream https://github.com/moremoban/moban.git`
1313
9. Type ` git remote -v ` and you should see <br>
1414
```
@@ -20,7 +20,23 @@ Fork [moban](https://github.com/moremoban/moban) by clicking "Fork".
2020

2121
When you want to update your local copy type <br> `git fetch upstream` <br> `git merge upstream/master` <br> `git push`
2222

23-
Steps for creating a Pull Request
23+
## Run unit tests
24+
25+
1. please install unit test requirements:
26+
27+
```
28+
$ pip install tests/requirements.txt
29+
```
30+
31+
2. Then run
32+
33+
```
34+
$ make
35+
```
36+
37+
When you enable travis-ci on your own account, you shall see travis-ci running a build on each of your pushed commit to your own fork.
38+
39+
## Steps for creating a Pull Request
2440
1. Checkout to the master branch `git checkout master`
2541
3. Start a new branch with a suitable name `git checkout -b branch_name`
2642
4. Develop a new feature or solve an existing issue

tests/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ codecov
33
coverage
44
mock
55
flake8
6+
moban

0 commit comments

Comments
 (0)