training-guides/doc/upstream-training/source/slides/workflow-setup-git-and-commit-messages.rst
Kendall Nelson 81642be7a9 [upstream] Remove Tags
This patch removes the tags table from the site and tags from the
slides. Since the content has moved out of the slides and into the
contributor guide, the tags are not really useful anymore. Moreover,
they weren't being maintained as new slide decks were added anyway.

Change-Id: I7f10d47364e3792177e34f915280c2ae025d65d9
2018-10-05 16:03:57 -07:00

1.4 KiB

Setup git & Commit Messages

image

Learning Exercise

  • Open the Setup and Learn GIT section of the Contributor Guide
  • Read the material
  • Ask the mentors questions
  • Get ready to go through the exercises

Exercise 1

  • Configure your workspace
    • git config
    • install git review

Exercise 2

Write a summary line for each of the following scenarios:

  • Someone left a print statement that was used for testing during development that is being added to the logs
  • There are unused arguments being passed into a method that is used in several different files

Share both in our IRC channel.

Exercise 3

Write a commit message body to expand on each of the following summary lines. Feel free to make up details to make the context more realistic. Share your favorite in IRC.

  • Minimize database queries
  • Added unit tests to cover untested methods

Exercise 4

Write a commit message for the bug you created during our earlier exercise. Include a summary line, body, and the required exernal references along with any optional external references you think it may benefit from.

Share the commit message with one or two people at your table. Give them feedback on their commit messages.