Workflow

Workflow Proposal

Diagram Workflow

Working with git (locally):

1. Make sure I am on master,
   git pull
2. Work through my changes (still on master branch)
3. Once I am ready to commit (on terminal or git-bash)
   git status - to see files affected
   git stash - to temporarily save my changes
   git branch feature/i51 - to create the new branch feature/i{issueNumber} or bugfix/i{issueNumber}
   git checkout to-new-branch
git stash pop - after this hopefully no merging conflicts exists, but in case they do, use PyCharm UI to resolve.
4. Finally we are ready to commit to our new branch. I use PyCharm commit tab to select files and add corresponding commit message. It might be a good idea to start all commit messages including the issue number, like so: "#i51: ignore unwanted files". Remember to keep the commit message descriptive but short.
5. Use PyCharm to push your changes, a remote branch with the same name will be automatically created.

Creating PRs with GitHub

1. Visit the Pull Request tab and create a PR from the recently added. Include issue on the PR.
2. Sit, relax and wait for feedback 😃