Home

Contribution Checklist!

Breakdown from Feature to Tasks

• Feature/(Optional) Epic (Label) > Story (Issue) > Tasks (Issues)
• Each story must have a feature label (name of feature), an optional epic label, and a "story" label
• Each task must have a "task" label, the label corresponding to the feature it belongs to, and a link in its description to the story it is borne out of

Creating Stories

• Give a short name for each story
• Write the full story in the description: As user X, I want to do Y, so I can accomplish Z
• Write the number of story points (e.g. 0, 1, 3, 5, 7, 11, etc)
• Write the priority or value (e.g. low priority)
• Write the risk (e.g. low risk)
• Assign each story to a feature (i.e. assign a label)
• Reference/Link all tasks borne out of the story within the story's description
• Assign the iteration (e.g. sprint 1)
• Estimate the ideal time for the story as a whole (in ideal-hours)
• Estimate the ideal time of each of the related tasks (e.g. 3 ideal-hours)
• Link all commits, arch diagrams, summaries of discussions, etc
• Write the unit tests
• Write the demo steps
• Get TA sign-off

Committing

• Always include the issue number in each commit message (e.g. #51)
• Always give a good description of what the commit is intended to do (e.g. Fixed flashing bug in the main activity)
• Format: [#51] Fixed flashing bug in the main activity

Pull Requests

• Always commence a PR from the Develop branch to your feat/bug/env branch
• Assign 2 people to review the PR
• Add comments, resolve them, repeat until satisfied
• Execute PR
• Update the Change Log in this wiki accordingly

Branches

• Your feat/bug/env branch: Please create a branch when you want to contribute to the repo.
• Develop: Please make PR to this branch during sprints from your feat/test/env branch branch.
• Master: This branch will be updated at the end of every sprint via the develop branch.
• Release: This branch will be updated at the end of every release via the master branch.

Branch Naming Convention

• feat/<feature_name>_<story#>

• <feature_name> should not contain capital letters, only underscores

• <story#> is the issue number corresponding to the story representing the branch

• bug/<feature_name>_<bug#>

• <feature_name> same as the feature-branch variant (the feature the bug belongs to)

• <bug#> is the issue number corresponding to the bug

• env/<affected_environment_component>_<issue#>

• <affected_environment_component> same as above, but just list the component

• <issue#> the issue number