Skip to content

Project Cards, Issues, Git Branches, Pull Request Guide

Torey Littlefield edited this page Mar 18, 2023 · 2 revisions

Project Cards (Issues)

Project Board

Here's the project board to see the issues https://github.com/orgs/TeamPetPoison/projects/3/views/1

Ready to work

These are cards that are unassigned (unless someone forgot to move their card) and can be picked up. Don't forget to assign yourself once you've picked up an issue.

In Progress

Once you've started working on your issue please move it to in progress status (column)

Code Review

Once you've request a code review please move the card here

Done

Once the branch is merged it should be automatically moved by GitHub to the done column but if it doesn't you or someone else can do that.

Creating Issues / Reporting Bugs / Ideas you'd like to Add

If you have an idea that you want be a feature, report a bug, or for whatever other reason you want to create new issues you can do so.

Here and just click the new issue button https://github.com/TeamPetPoison/pethealthreportservice/issues

It should be automatically added to the project board but if not you can link the project to the issue. It should appear in the very first column (status) as unsorted.

Quick Fix

if you have a real quick fix and don't want to create an issue please follow the branch name convention just drop the issue. You might have a card to the board however linking to the PR #.

Git Branches

Format

For branch names use the format all lowercase and use dashes (-) not spaces or anything else, please

initials/issue-#-pick-a-name-based-off-what-you're-fixing

Example

My name is Torey Littlefield and let's say I picked up issue #3 https://github.com/TeamPetPoison/pethealthreportservice/issues/3 from the project board

tl/issue-3-setup-admin-env

Pull Requests

In your pull request please include a link to your issue and a brief description. Please use a short descriptive title.

Example

See https://github.com/TeamPetPoison/pethealthreportservice/pull/11 as an example.

Code Review

When started put WIP in the title of your PR. When you're ready for review remove WIP from the title and request some reviewers. Please add comments on your code for reviewers for anything you'd like to point out.