planing in the project
Epic
a large body of work - feature, release, etcIssue
a building block of work - story, bug, task, etc
all issues include checklists (Subtasks
) to complete
[section 1] [section 2] [section 3]
-
[section 1] has to be verb what managers/developers want adding? deleting? fixing? testing?
-
[section 2] has to be feature what managers/develops discussing about feature name?
-
[section 3] has to be noun where managers/develops discussing about function name? page name?
example:
- adding sortable table in audit history page
- making paginable table in audit history page
-
Info explanation to answer this issue is requirred
-
Complete Condition explanation to answer this issue is completed
- title
- description
- assignee
- created_by
- due_time
- start_time
- priority
- severity
main
release
${development_branch}
${hotfix_branch}
main
is development branch
release
is staging branch
release
with taf is production branch
${development_branch}
is local/origin development branch
${hotfix_branch}
is local/origin hot fix branch
default branch main
create ${development_branch} from main
create ${hotfix_branch} from release
git checkout -b ${issue_system}_${issue_id}
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing or correcting existing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
closes ${issue_id}
main
only pull request from${development_branch}
release
only pull request frommain
- test report
- release note
Labels should be clear, descriptive, and consistently used to categorize and prioritize issues. Labels help in filtering and organizing issues.
Tags are used to mark specific versions or releases of the project. Tags should be descriptive and follow a versioning scheme.