GitHub Development Workflow - earthcubeprojects-chords/chords GitHub Wiki
Development Workflow Overview
- Create issue in github if it doens't already esist
- Add a "Issue Type" label to the issue
- Create new working branch from the development branch
- Branch naming scheme: {issue-type}-{issue-number}-{issue-descriptor}
- Perform work
- TEST and ensure your code is in a working state before pushing to origin!
- Merge working branch back in to development
- Submit pull request to merge development in to master
- Remove merged branch
Labels
Issue Type
The issue type selected should correspond to the branch name
- feature, fix, security, documentation, question, report
Issue Category
The category is to provide some context for the issue and to make it possible to sort and generate basic metrics is necessary.
- Bug, UI, Theming, Database, Configuration, Ops
Priority
- HIGH PRIORITY, won't fix
Workflow status
- CHECKED OUT
Issue Naming
Issues should have a brief by descriptive name, and need to be tagged with a relevant
Branch Naming
Branches should be named according to the following pattern:
{issue-type}-{issue-number}-{issue-descriptor}
NO WORK SHOULD EVER BE DONE DIRECTLY ON MASTER
Committing to a branch should always include the #issue_id so that github can automatically link the commit to the related issue
Checking out and issue
Pull requests
Commit tags Include the #issue-number in the message for each commit