Workflow

If you are already familiar and have your own way of doing things, please continue with your preferences. Feel free to add it here or if you'd like to improve the one written down, you are welcome todo so.

Workflow Proposal

If you are totally new to working with Git & GitHub, below there is a reference you can use.

Working with git (locally)

1. Before I start making changes, I make sure to be on master branch and run
   git pull
2. Work through my changes (still on master branch)
3. Once I am ready to commit (on terminal or git-bash) I execute
   git status - to see modified files (can also see on PyCharm Commit tab)
   git stash - to temporarily store the current state of your working directory and go back to a clean state (without your changes)
   git branch feature/i51 - to create the new branch feature/i{issueNumber} or bugfix/i{issueNumber}
   git checkout to-new-branch - you could also use git checkout -b feature/i51 to create and checkout the new branch
   git stash pop - after this, hopefully no merging conflicts exists, but in case they do, use PyCharm UI to resolve them.
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: #51: 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 as the local will be automatically created.

Creating PRs with GitHub

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