Skip to content
Kevin Hoffman edited this page Feb 21, 2018 · 21 revisions

Format

{type}({scope}): {subject line}

Each issue should include a prefix with type and scope followed by a subject line.

Examples

  • build(webpack): add JS sourcemaps
  • doc(donor): improve clarity of DocBlocks
  • feat(admin-report): add summary report for all forms
  • style(donation): format class according to WPCS
  • fix: prevent white screen after donation

DO

  1. Begin each issue title with a {type}({scope}): prefix.
  2. Use the imperative mood.
  3. Wrap any code, such as Class_Name, method(), $property, $variable, or @tag, in backticks.
  4. Write goal-oriented issue titles. Think about the problem that needs solved and turn it into a goal.
  5. Assign each issue an estimate of story points based on complexity. This number can be updated once the issue is better understood.
  6. Follow the issue template within reason. Before submitting, remove all HTML comments and any headings that do not apply. This will result in cleaner presentation of issue when it is consumed via an API by third-party apps like Slack.

DO NOT

  1. Do not end issue titles with a period.
  2. Do not exceed 72 characters in issue title.
  3. Do not include multiple goals in a single issue.

Roles & Capabilities

  • Support/Marketing/Community
    • Add issue
  • Development
    • Add issue
    • Add estimate
  • Senior Development
    • Add issue
    • Add estimate
    • Add assignee
    • Add to sprint (milestone)
    • Add to release
    • Add to epic
Clone this wiki locally