Contributing - adventures-in/chat_app GitHub Wiki

General Notes

  • currently PRs should be on to test, with the build & deploy branches used via a GitHub app
  • everyone is a collaborator on the project so can create branches and push to any branch (except test, build & deploy)
  • we are using the Gitflow Workflow

Steps for contributing

  1. Select or create an issue and assign yourself.
  2. Branch off test with a relevant name, push your changes to the branch until you're ready to merge.
  3. Create a PR onto test and (if not already present) add fixes #<issue_num> to the PR comment
  4. Request a review
  5. When a reviewer approves your PR
    1. Update your branch if needed, using the Update button in GitHub or merging test into your branch and resolving any conflicts then pushing it up.
    2. Merge your PR and delete the branch.

Reviewing a PR

  • please suggest changes in the form of a request rather than a command
  • when you approve, leave the PR author to merge

A Contributing Workflow for VSCode

  1. Go to the Issues page and click on an issue you want to work on:
Screen Shot 2020-06-10 at 8 59 56 pm
  1. Click "assign yourself"
Screen Shot 2020-06-10 at 9 05 35 pm
  1. If you haven't already, install the Github extension
Screen Shot 2020-06-10 at 10 28 32 pm
  1. Click on the Github extension
Screen Shot 2020-06-10 at 10 31 28 pm
  1. Click My Issues, find the issue just assigned yourself and hit the right arrow to create a branch
Screen Shot 2020-06-10 at 10 38 04 pm

There are a lot of other things the VSCode Github extension can do, see Working with GitHub Issues in Visual Studio Code.

Some other ways to work on issues: VSCode Github GIF

⚠️ **GitHub.com Fallback** ⚠️