Skip to content

Commit e790bc0

Browse files
committed
feat: Add Jira issue creation guidelines and templates
* Added new `.cursor/rules` to guide AI on creating Jira issues. * Introduced `jira-formatting.mdc` to define Jira Markdown syntax and formatting requirements. * Included `srvkp-jira-template.mdc` for creating new Jira stories using a standard template. * Provided `srvkp-jira-bug-template.mdc` for generating Jira bug reports with a specific structure. * Ensured AI output for Jira issues adhered to correct Jira Markdown and company templates. Signed-off-by: Chmouel Boudjnah <[email protected]>
1 parent fdd6549 commit e790bc0

File tree

3 files changed

+119
-0
lines changed

3 files changed

+119
-0
lines changed

.cursor/rules/jira-formatting.mdc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
description: Ensures new Jira issues are formatted with correct Jira Markdown
3+
alwaysApply: false
4+
---
5+
6+
# Jira Issue Creation and Formatting
7+
8+
When asked to create a Jira issue (story or bug):
9+
10+
1. **Identify the issue type:** Determine if the user wants a "story" or a "bug".
11+
2. **Use the correct template:**
12+
* For stories, use the content from `.cursor/rules/srvkp-jira-template.mdc`.
13+
* For bug reports, use the content from `.cursor/rules/srvkp-jira-bug-template.mdc`.
14+
3. **Fill in the template:** Populate the template with the context and details provided by the user.
15+
4. **Output in Jira Markdown:** Ensure the entire final output strictly adheres to Jira's markdown syntax. Do not use standard markdown.
16+
17+
## Jira Markdown Quick Reference
18+
19+
* **Headings:** `h1.`, `h2.`, `h3.`, `h4.`, `h5.`, `h6.`
20+
* **Bold:** `*bold text*`
21+
* **Italic:** `_italic text_`
22+
* **Strikethrough:** `-strikethrough-`
23+
* **Monospaced:** `{{monospaced text}}`
24+
* **Bulleted List:** `* item` (or `- item`)
25+
* **Numbered List:** `# item`
26+
* **Blockquote:** `bq. Blockquote`
27+
* **Code Block:** `{code:language} ... {code}` or `{noformat} ... {noformat}`
28+
* **Link:** `[link text|http://example.com]`
29+
30+
Always produce a clean, copy-paste-ready output for a Jira text box.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
description: SRVKP Jira Bug Report Template
3+
alwaysApply: false
4+
---
5+
6+
# SRVKP Jira Bug Report Template
7+
8+
h3. *Description of problem:*
9+
10+
Workaround
11+
h3. *Prerequisites (if any, like setup, operators/versions):*
12+
h3. *Steps to Reproduce*
13+
14+
# <steps>
15+
16+
h3. *Actual results:*
17+
h3. *Expected results:*
18+
h3. *Reproducibility (Always/Intermittent/Only Once):*
19+
h3. *Acceptance criteria:*
20+
21+
*Definition of Done:*
22+
h3. *Build Details:*
23+
h3. *Additional info (Such as Logs, Screenshots, etc):*

.cursor/rules/srvkp-jira-template.mdc

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
description: SRVKP Jira Ticket Template
3+
alwaysApply: false
4+
---
5+
6+
# SRVKP Jira Ticket Template
7+
8+
h1. Story (Required)
9+
10+
As a <PERSONA> trying to <ACTION> I want <THIS OUTCOME>
11+
12+
_<Describes high level purpose and goal for this story. Answers the questions: Who is impacted, what is it and why do we need it? How does it improve the customer’s experience?>_
13+
14+
h2. *Background (Required)*
15+
16+
_<Describes the context or background related to this story>_
17+
18+
h2. *Out of scope*
19+
20+
_<Defines what is not included in this story>_
21+
22+
h2. *Approach (Required)*
23+
24+
_<Description of the general technical path on how to achieve the goal of the story. Include details like json schema, class definitions>_
25+
26+
h2. *Dependencies*
27+
28+
_<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>_
29+
30+
h2. *Acceptance Criteria (Mandatory)*
31+
32+
_<Describe edge cases to consider when implementing the story and defining tests>_
33+
34+
_<Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>_
35+
36+
h1. *INVEST Checklist*
37+
38+
Dependencies identified
39+
40+
Blockers noted and expected delivery timelines set
41+
42+
Design is implementable
43+
44+
Acceptance criteria agreed upon
45+
46+
Story estimated
47+
48+
h4. *Legend*
49+
50+
Unknown
51+
52+
Verified
53+
54+
Unsatisfied
55+
56+
h2. *Done Checklist*
57+
58+
* Code is completed, reviewed, documented and checked in
59+
60+
* Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
61+
62+
* Continuous Delivery pipeline(s) is able to proceed with new code included
63+
64+
* Customer facing documentation, API docs etc. are produced/updated, reviewed and published
65+
66+
* Acceptance criteria are met

0 commit comments

Comments
 (0)