GitHub scrum workflow
Turn any GitHub repository into a simple but powerful agile work environment.
Free, simple and fast so you can focus on the actual coding!
How it works
add your API token and run the script.
cp config/credentials.example.yml config/credentials.yml
echo "access_token: my-github-api-token" > config/credentials.yml
ruby prepare-repository.rb '<username>/<repo>'
- items are reported as issues
- points and meta data are assigned to items as labels
- milestones are used to group issues in sprints
1. Create issues as backlog items
To create a new backlog item, just create a new issue.
Once a new issue has been created, assign it the right labels and/or assign it to a sprint (milestone).
Issues allow you to have a conversation about the item and even allow you to create task lists inside the issue using GitHub's markdown.
2. Add labels to issues
Add the following labels to your repository:
Priorities
priority labels allow you to prioritize items in your backlog e.g.:
priority: lowestpriority: lowpriority: mediumpriority: highpriority: highest
Points
point labels allow you to to assign velocity points to individual items (issues) e.g. using Fibonacci numbers:
point: 1point: 2point: 3point: 5point: 8point: 13point: 21
Types
type labels allow you to easily filter items (issues) in the dashboard e.g.:
type:bug: bugtype:chore: chore, maintenance worktype:feature: new featuretype:infrastructure: infrastructure relatedtype:performance: performance relatedtype:refactor: refactortype:test: test related
Other
You can define and assign custom labels that you need within your workflow or organization.
3. Define sprints as projects
You can create a project for every sprint and add items.
This allows you to group items in sprints and track them by project in your issue dashboard. Create project for each release.
Overview
Image: Scrum primer.
Helpful links
Change log
v1.0.0
- Added documentation for issues, labels and milestones.