Skip to content

Commit ffa7aa2

Browse files
samsharafrozenhelium
authored andcommitted
feat: update pull request template and issue templates
1 parent bb9a501 commit ffa7aa2

File tree

7 files changed

+190
-99
lines changed

7 files changed

+190
-99
lines changed
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: Report a Technical or Visual Issue on the IFRC GO Website
2+
description: 'Encountered a bug or glitch? Let us know so we can address it!'
3+
labels: ['type: bug']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for helping improve the IFRC GO Website!
9+
Please fill out the form below with as much detail as possible. This will help us diagnose and fix the issue promptly.
10+
If the issue is visual, screenshots or videos are greatly appreciated.
11+
12+
- type: input
13+
attributes:
14+
label: 'Page URL'
15+
description: 'The URL of the page where you encountered the issue.'
16+
placeholder: 'https://go.ifrc.org/'
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
attributes:
22+
label: 'Environment'
23+
description: 'Please select the environment where the bug occurred.'
24+
options:
25+
- 'Alpha'
26+
- 'Staging'
27+
- 'Production'
28+
validations:
29+
required: true
30+
31+
- type: input
32+
attributes:
33+
label: 'Browser'
34+
description: 'Which browser are you using? (e.g., Chrome, Firefox, Safari)'
35+
placeholder: 'Chrome'
36+
validations:
37+
required: true
38+
39+
- type: input
40+
attributes:
41+
label: 'Browser Version'
42+
description: 'What version of the browser are you using?'
43+
placeholder: '103.0.5060.134'
44+
validations:
45+
required: false
46+
47+
- type: input
48+
attributes:
49+
label: 'Operating System'
50+
description: 'What operating system are you using? Include the version if possible.'
51+
placeholder: 'Windows 10'
52+
validations:
53+
required: false
54+
55+
- type: dropdown
56+
attributes:
57+
label: 'Priority'
58+
description: 'How urgent is this issue?'
59+
options:
60+
- 'Low (Minor inconvenience)'
61+
- 'Medium (Affects functionality, but there is a workaround)'
62+
- 'High (Major functionality is broken)'
63+
- 'Critical (Site is unusable)'
64+
validations:
65+
required: false
66+
67+
- type: textarea
68+
attributes:
69+
label: 'Steps to Reproduce the Issue'
70+
description: |
71+
Please describe the issue in detail, including:
72+
1. What actions led to the issue?
73+
2. What did you expect to happen?
74+
3. What actually happened?
75+
4. If possible, attach screenshots or videos demonstrating the problem.
76+
placeholder: |
77+
1. I clicked on...
78+
2. I expected the page to...
79+
3. Instead, I saw...
80+
4. [Attach screenshots/videos if available]
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
attributes:
86+
label: 'Additional Context (Optional)'
87+
description: |
88+
Provide any extra details, such as:
89+
- Related links.
90+
- Previous occurrences of this issue.
91+
- Workarounds you have tried.
92+
placeholder: 'This issue also happened on [link].'
93+
validations:
94+
required: false
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature Request
2+
description: Suggest a new idea or enhancement for the IFRC GO project.
3+
title: "[Feature]: "
4+
labels: ['type: feature-request']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting a new feature!
10+
Please provide as much detail as possible to help us understand and evaluate your idea.
11+
Before submitting, please search our issue tracker to ensure this isn’t a duplicate request.
12+
13+
- type: textarea
14+
attributes:
15+
label: Feature Description
16+
description: |
17+
Describe your feature request in detail, including:
18+
- What the feature is.
19+
- Why it’s needed and how it will improve the project.
20+
- How it will benefit users (e.g., "As a user, I want to [do something] so that [desired outcome].").
21+
placeholder: |
22+
As a user, I want to filter search results by date so that I can quickly find recent information.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Additional Context
29+
description: |
30+
Provide any extra details or supporting information, such as:
31+
- Links to references or related resources.
32+
- Examples from other projects or systems.
33+
- Screenshots, mockups, or diagrams.
34+
*Tip: You can attach files by clicking here and dragging them in.*
35+
placeholder: |
36+
Here’s a link to a similar feature in another project: [link].
37+
I’ve also attached a mockup of what this could look like.
38+
validations:
39+
required: false
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Epic
2+
description: Track a larger initiative with multiple related tasks and deliverables for IFRC GO project.
3+
title: "[Epic]: "
4+
labels: ['type: epic']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Epic Overview
10+
Use this to define a large, overarching initiative. An epic typically represents a high-level goal or feature that can be broken down into smaller, actionable issues.
11+
12+
- type: textarea
13+
attributes:
14+
label: Epic Summary
15+
description: |
16+
Provide a clear and concise summary of the epic.
17+
- What is this epic about?
18+
- What problem does it solve or what goal does it achieve?
19+
- How does it align with the project’s objectives?
20+
placeholder: |
21+
Example:
22+
This epic focuses on implementing a new feature.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Additional Context or Resources
29+
description: |
30+
Provide any additional information, links, or resources that will help the team understand and execute this epic.
31+
placeholder: |
32+
Examples:
33+
- Link to design mockups: [link]
34+
- Technical specs document: [link]
35+
- Reference to similar features: [link]
36+
validations:
37+
required: false

.github/ISSUE_TEMPLATE/bug-report---production.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug-report---staging.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
1-
## Addresses:
2-
- XXX
1+
## Summary
2+
Provide a brief description of what this PR addresses and its purpose.
33

4-
## Depends on:
5-
- XXX
4+
## Addresses
5+
- Issue(s): _List related issues or tickets._
6+
7+
## Depends On
8+
- Other PRs or Dependencies: _List PRs or dependencies this PR relies on._
69

710
## Changes
811
- Detailed list or prose of changes
912
- Breaking changes
1013
- Changes to configurations
1114

12-
## This PR doesn't introduce:
13-
- [ ] typos
14-
- [ ] conflict markers
15-
- [ ] unwanted comments
16-
- [ ] temporary files, auto-generated files or secret keys
17-
- [ ] `console.log` meant for debugging
18-
- [ ] codegen errors
15+
## This PR Ensures:
16+
- [ ] No typos or grammatical errors
17+
- [ ] No conflict markers left in the code
18+
- [ ] No unwanted comments, temporary files, or auto-generated files
19+
- [ ] No inclusion of secret keys or sensitive data
20+
- [ ] No `console.log` statements meant for debugging
21+
- [ ] `pnpm lint` runs without errors
22+
- [ ] `pnpm typecheck` passes (no type errors)
23+
- [ ] `pnpm knip` passes
24+
- [ ] `pnpm build` completes successfully
25+
26+
## Additional Notes
27+
_Optional: Add any other relevant context, screenshots, or details here._

0 commit comments

Comments
 (0)