Development guidelines¶
Setup work environment¶
- Clone project repository:
git clone https://github.com/crypotex/taas.git
- Go to the project root folder:
cd taas
- Create separated python environment and activate it (recommended):
virtualenv -p /usr/bin/python3 venv
source venv/bin/activate
- Install project requirements:
pip setup.py develop
- Run tests:
python setup.py test
- Migrate database:
python manage.py migrate
- Run server:
python manage.py runserver
Flow for tasks¶
- Create a new branch from develop.
git checkout develop
git pull origin develop
git checkout -b feature/task-id (task-id is number of the issue in github. For example 7.)
- Write code.
- Create tests.
- Verify that tests are passing.
- If some important functionality is implemented, add documentation for it with screenshots if necessary.
- After work on the task is completed:
git push origin feature/task-id
- Go to the github and make Pull request to the develop branch.
- Assign Pull request to the team member.
- Add Done label to the Github issue.
Commit rules¶
- Commit message should be 50 characters or less.
- Do not make large commits.
- At the end of the commit specify task number using Issue #task-id
- Example of proper commit message:
Create initial project structure
Issue #7
