Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (41 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 1.81 KB

Fork moban by clicking "Fork".

Using virtualenv and Remote Configuration

  1. pip3 install virtualenv
  2. Move to the location where you want to setup moban and type mkdir moban in the terminal
  3. cd moban
  4. Type virtualenv venv
  5. source venv/bin/activate
  6. git clone https://github.com/YOUR_USERNAME/moban.git
  7. cd moban
  8. pip install -r requirements.txt
  9. git remote add upstream https://github.com/moremoban/moban.git
  10. Type git remote -v and you should see 
   origin https://github.com/YOUR_USERNAME/moban.git (fetch)
   origin https://github.com/YOUR_USERNAME/moban.git (push) 
   upstream https://github.com/moremoban/moban.git (fetch)
   upstream https://github.com/moremoban/moban.git (push)

When you want to update your local copy type
git fetch upstream
git merge upstream/master
git push

Run unit tests

  1. please install unit test requirements:
$ pip install tests/requirements.txt
  1. Then run
$ make

In order to format the code automatically

you will need python 3.6 to run "make format"

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.

Steps for creating a Pull Request

  1. Checkout to the master branch git checkout master
  2. Start a new branch with a suitable name git checkout -b branch_name
  3. Develop a new feature or solve an existing issue
  4. Add the changed files git add file_name
  5. Commit with a suitable message git commit -m " Changes made "
  6. Push git push origin branch_name
  7. Go to the Github Repository and create a pull request to the dev branch

Commit messages

We use git emojis for commit messages. Please read the guide.