Guidelines for contributing to this project. Must be strictly followed by all team members.
This will guide you from cloning this repository to pushing your contributions.
Fork this repository to get a personal copy on your github account
To clone the forked repository to your local machine, open command prompt and run:
git clone https://github.com/your-account-name/zc_plugin_dm
Change to the project directory you just cloned
cd zc_plugin_dm
To set upstream remote so you can pull changes from upstream to update your repo run:
git remote add upstream https://github.com/zurichat/zc_plugin_dm
Checkout develop branch by running
git checkout develop_test_2
Feature Branching Workflow means you create a new branch for every feature or issue you are working on. It is goood practice for the branch name to end with the issue id. So if an issue id is #5 and issue title is Update ReadMe.md then our branch name would be update-readme-#5. create and checkout feature branch by running:
git checkout -b issue-name-id
To setup the development environment to run project run:
pip install pipenv
pipenv install -r requirements.txt
Migrate the database by running:
python manage.py migrate
Create a .env file and add the following config vars:
SECRET_KEY=Averyrandomstringthatwillbehardforanyonetoguessevenyou
DEBUG=True
EMAIL_HOST_USER=
EMAIL_HOST_PASSWORD=
save the file.
If you want to test the development environment run:
python manage.py runserver
When you have finished making changes perform the following to commit your code:
git status
git add --all
git commit -m "descriptive commit message"
Pull latest update from the upstream remote repo by running:
git pull upstream develop
Push your new fix or feature to the origin remote branch of your feature. If your feature branch title is update-readme-#5 then run:
git push origin update-readme-#5
Goto your github account and make a Pull Request to merge your changes to upstream.