Skip to content

feat(GCP-655): Add Jira Initiative template - #82

Merged
openshift-merge-bot[bot] merged 2 commits into
mainfrom
gcp-655-initiative-template
Jul 15, 2026
Merged

openshift-merge-bot[bot] merged 2 commits into
mainfrom
gcp-655-initiative-template

Conversation

@katherinekeane

@katherinekeane katherinekeane commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add docs/jira-initiative-template.md for creating Jira Initiatives — internal/architectural work at Level 4 (same level as Features, but for non-customer-facing work)
  • Update Definition of Ready to reference the new Initiative template instead of the Feature template placeholder
  • Add Initiative template to the hierarchy doc's Related Documentation section

Closes GCP-655 (template portion — the create-initiative skill is in a separate ai-helpers PR).

Context

Initiatives represent internal capability work (performance testing infrastructure, architectural improvements, tooling) that doesn't directly contribute to the product roadmap. The DoR already had Initiative criteria but noted "A dedicated Initiative template will be created in a follow-up task." This PR delivers that template.

Key differences from Feature template:

  • Context emphasizes strategic/architectural goals rather than customer requirements
  • Technical Approach promoted from optional to recommended
  • Internal Impact section replaces customer-facing orientation
  • No "Demo Critical" metadata

Test plan

  • Template follows the same structural conventions as existing templates (Feature, Epic, Story, Task)
  • DoR Initiative section now references jira-initiative-template.md directly
  • Hierarchy doc includes Initiative template in Related Documentation
  • Example Initiative is realistic and demonstrates all required sections

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a new Jira Initiative Template with a standardized structure and a fully filled example.
    • Updated initiative readiness guidance to link directly to the new template.
    • Expanded related documentation references in the Jira hierarchy and definition-of-ready materials to include the initiative template.

@openshift-ci
openshift-ci Bot requested review from floresroger and patjlm July 6, 2026 12:04
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 09468d00-27f6-4094-8ec9-738c5a3545c0

📥 Commits

Reviewing files that changed from the base of the PR and between a89fa28 and 287646d.

📒 Files selected for processing (1)
  • docs/jira-initiative-template.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/jira-initiative-template.md

Walkthrough

This PR adds a Jira Initiative template document and updates the Definition of Ready and Jira hierarchy documentation to reference it.

Changes

Jira Initiative Documentation

Layer / File(s) Summary
Initiative template definition
docs/jira-initiative-template.md
Adds a Level 4 Jira Initiative template with required sections and a completed example initiative.
Documentation references
docs/definition-of-ready.md, docs/jira-hierarchy.md
Replaces prior initiative guidance with a direct template reference and adds the template to related-documentation lists.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: patjlm, apahim, cblecker

🚥 Pre-merge checks | ✅ 11
✅ Passed checks (11 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding a Jira Initiative template and related documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
No-Weak-Crypto ✅ Passed The only changed file is a markdown template update; no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB or secret-comparison code appears in the diff.
Container-Privileges ✅ Passed PR only changes a Markdown doc; no container/K8s manifests were modified, so no privileged/hostPID/allowPrivilegeEscalation settings were introduced.
No-Sensitive-Data-In-Logs ✅ Passed The PR only changes documentation; the new template and updates contain no logging code or sensitive fields like secrets, tokens, PII, hostnames, or customer data.
No-Hardcoded-Secrets ✅ Passed No hardcoded secrets, credential URLs, private keys, or secret-like literals were found in the touched docs.
No-Injection-Vectors ✅ Passed PASS: The PR only changes docs, and scans of the touched files/diff found no SQL/shell/eval/pickle/yaml/os.system/innerHTML injection sinks.
Ai-Attribution ✅ Passed PASS: The two PR commits both include Assisted-by trailers for Claude Code, and neither uses Co-Authored-By; the lone Co-Authored-By hit is outside this PR.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch gcp-655-initiative-template

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cblecker cblecker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the Related Documentation footer at the bottom of this file lists Story, Epic, Feature, and Task templates but doesn't include the new Initiative template. jira-hierarchy.md was correctly updated — just need the matching entry here:

- [Jira Initiative Template](./jira-initiative-template.md) - Initiative structure

(between Feature and Task to match the ordering in the hierarchy doc)

Comment thread docs/jira-initiative-template.md Outdated

---

## Technical Approach

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the Feature template (## Technical Approach (Optional)) and Epic template (## Technical Details (Optional)), consider marking this ## Technical Approach (Optional) — Initiatives may not have a decided approach at creation time either.

Add jira-initiative-template.md for internal/architectural work at Level 4
(same hierarchy level as Features, but for non-customer-facing work).

Update Definition of Ready to reference the new template instead of the
Feature template placeholder, and add the template to the hierarchy doc's
Related Documentation section.

Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@katherinekeane
katherinekeane force-pushed the gcp-655-initiative-template branch from f7a5a26 to a89fa28 Compare July 6, 2026 19:04
@katherinekeane
katherinekeane marked this pull request as draft July 7, 2026 15:52
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 7, 2026
@katherinekeane
katherinekeane marked this pull request as ready for review July 8, 2026 10:10
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 8, 2026
@openshift-ci
openshift-ci Bot requested review from cblecker and ckandag July 8, 2026 10:10
@katherinekeane
katherinekeane marked this pull request as draft July 8, 2026 10:24
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 8, 2026
For consistency with Feature and Epic templates.

Assisted-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@katherinekeane

Copy link
Copy Markdown
Contributor Author

Thanks @cblecker! Good catch — updated ## Technical Approach to ## Technical Approach (Optional) for consistency with the Feature and Epic templates.

@katherinekeane
katherinekeane marked this pull request as ready for review July 8, 2026 10:33
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 8, 2026
@openshift-ci
openshift-ci Bot requested a review from apahim July 8, 2026 10:33
katherinekeane added a commit to katherinekeane/ai-helpers that referenced this pull request Jul 9, 2026
Add initiative as a new supported issue type (Level 4, internal/architectural
work — same hierarchy level as Feature but non-customer-facing).

- Add reference/create-initiative.md following the create-feature.md pattern:
  problem statement, internal impact, success criteria, interactive workflow,
  description template, and anti-patterns
- Update skills/create/SKILL.md: add initiative to type routing table,
  arguments, hierarchy diagram, parent linking table, pre-validation, error
  message, and usage examples
- Update reference/gcp-hcp.md: add Initiative to issue types, MCP fields
  table, Epic Linking section, Initiative Template section, and Maintenance
  upstream sources — synced from openshift-online/gcp-hcp#82
- Bump jira plugin version 0.8.2 → 0.8.3

Note: docs/index.html not regenerated (Docker unavailable locally).
Maintainers can run `make update` after merge if needed.

Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
katherinekeane added a commit to katherinekeane/ai-helpers that referenced this pull request Jul 9, 2026
Add initiative as a new supported issue type (Level 4, internal/architectural
work — same hierarchy level as Feature but non-customer-facing).

- Add reference/create-initiative.md following the create-feature.md pattern:
  problem statement, internal impact, success criteria, interactive workflow,
  description template, and anti-patterns
- Update skills/create/SKILL.md: add initiative to type routing table,
  arguments, hierarchy diagram, parent linking table, pre-validation, error
  message, and usage examples
- Update reference/gcp-hcp.md: add Initiative to issue types, MCP fields
  table, Epic Linking section, Initiative Template section, and Maintenance
  upstream sources — synced from openshift-online/gcp-hcp#82
- Bump jira plugin version 0.8.2 → 0.8.3

Note: docs/index.html not regenerated (Docker unavailable locally).
Maintainers can run `make update` after merge if needed.

Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
katherinekeane added a commit to katherinekeane/ai-helpers that referenced this pull request Jul 9, 2026
Add initiative as a new supported issue type (Level 4, internal/architectural
work — same hierarchy level as Feature but non-customer-facing).

- Add reference/create-initiative.md following the create-feature.md pattern:
  problem statement, internal impact, success criteria, interactive workflow,
  description template, and anti-patterns
- Update skills/create/SKILL.md: add initiative to type routing table,
  arguments, hierarchy diagram, parent linking table, pre-validation, error
  message, and usage examples
- Update reference/gcp-hcp.md: add Initiative to issue types, MCP fields
  table, Epic Linking section, Initiative Template section, and Maintenance
  upstream sources — synced from openshift-online/gcp-hcp#82
- Bump jira plugin version 0.8.2 → 0.8.3

Note: docs/index.html not regenerated (Docker unavailable locally).
Maintainers can run `make update` after merge if needed.

Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@cblecker

Copy link
Copy Markdown
Contributor

@katherinekeane I don't actually see any changes pushed. Can you check again?

@katherinekeane

Copy link
Copy Markdown
Contributor Author

Sorry about that @cblecker — the commit was sitting locally and I forgot to push it. Should be there now: marked ## Technical Approach as (Optional) in the initiative template for consistency with the Feature and Epic templates.

@cblecker

Copy link
Copy Markdown
Contributor

/lgtm
/approve
/label tide/merge-method-squash

@openshift-ci openshift-ci Bot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jul 15, 2026
@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2026
@openshift-ci

openshift-ci Bot commented Jul 15, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cblecker, katherinekeane

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 15, 2026
@openshift-merge-bot
openshift-merge-bot Bot merged commit 452620f into main Jul 15, 2026
5 checks passed
@openshift-merge-bot
openshift-merge-bot Bot deleted the gcp-655-initiative-template branch July 15, 2026 21:54
openshift-merge-bot Bot pushed a commit to openshift-eng/ai-helpers that referenced this pull request Jul 16, 2026
* feat(jira): add initiative issue type support

Add initiative as a new supported issue type (Level 4, internal/architectural
work — same hierarchy level as Feature but non-customer-facing).

- Add reference/create-initiative.md following the create-feature.md pattern:
  problem statement, internal impact, success criteria, interactive workflow,
  description template, and anti-patterns
- Update skills/create/SKILL.md: add initiative to type routing table,
  arguments, hierarchy diagram, parent linking table, pre-validation, error
  message, and usage examples
- Update reference/gcp-hcp.md: add Initiative to issue types, MCP fields
  table, Epic Linking section, Initiative Template section, and Maintenance
  upstream sources — synced from openshift-online/gcp-hcp#82
- Bump jira plugin version 0.8.2 → 0.8.3

Note: docs/index.html not regenerated (Docker unavailable locally).
Maintainers can run `make update` after merge if needed.

Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* fix: address PR review comments on initiative support

- Add "initiatives" to SKILL.md prose description (line 12)
- Add Initiative→Outcome to parent field list and pre-validation table
- Remove incorrect "Level 4" label from create-initiative.md and gcp-hcp.md

Note: docs/index.html still requires `make update` (Docker/Podman unavailable
locally) — CI check for plugins-doc-up-to-date remains failing.

Assisted-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: regenerate index.html via skillsaw

Fixes the plugins-doc-up-to-date CI check. Removes a spurious
create-initiative entry that was manually added — reference files
don't register as skills in the docs index.

Assisted-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: address CodeRabbit nits on initiative support

- Show full hierarchy Outcome → Initiative → Epic → Story in gcp-hcp.md
- Update gcp-hcp.md sections list to match create-initiative.md template
- Add initiatives to missing-project-key error message in SKILL.md

Assisted-by: Claude Sonnet 4.6 <noreply@anthropic.com>
floresroger pushed a commit to floresroger/gcp-hcp that referenced this pull request Jul 20, 2026
* feat(GCP-655): add Jira Initiative template

Add jira-initiative-template.md for internal/architectural work at Level 4
(same hierarchy level as Features, but for non-customer-facing work).

Update Definition of Ready to reference the new template instead of the
Feature template placeholder, and add the template to the hierarchy doc's
Related Documentation section.

Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* docs: mark Technical Approach as Optional in initiative template

For consistency with Feature and Epic templates.

Assisted-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants