-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: update pull request template and issue templates
- Loading branch information
Showing
7 changed files
with
190 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
name: Report a Technical or Visual Issue on the IFRC GO Website | ||
description: 'Encountered a bug or glitch? Let us know so we can address it!' | ||
labels: ['type: bug'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for helping improve the IFRC GO Website! | ||
Please fill out the form below with as much detail as possible. This will help us diagnose and fix the issue promptly. | ||
If the issue is visual, screenshots or videos are greatly appreciated. | ||
|
||
- type: input | ||
attributes: | ||
label: 'Page URL' | ||
description: 'The URL of the page where you encountered the issue.' | ||
placeholder: 'https://go.ifrc.org/' | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
attributes: | ||
label: 'Environment' | ||
description: 'Please select the environment where the bug occurred.' | ||
options: | ||
- 'Alpha' | ||
- 'Staging' | ||
- 'Production' | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: 'Browser' | ||
description: 'Which browser are you using? (e.g., Chrome, Firefox, Safari)' | ||
placeholder: 'Chrome' | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: 'Browser Version' | ||
description: 'What version of the browser are you using?' | ||
placeholder: '103.0.5060.134' | ||
validations: | ||
required: false | ||
|
||
- type: input | ||
attributes: | ||
label: 'Operating System' | ||
description: 'What operating system are you using? Include the version if possible.' | ||
placeholder: 'Windows 10' | ||
validations: | ||
required: false | ||
|
||
- type: dropdown | ||
attributes: | ||
label: 'Priority' | ||
description: 'How urgent is this issue?' | ||
options: | ||
- 'Low (Minor inconvenience)' | ||
- 'Medium (Affects functionality, but there is a workaround)' | ||
- 'High (Major functionality is broken)' | ||
- 'Critical (Site is unusable)' | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: 'Steps to Reproduce the Issue' | ||
description: | | ||
Please describe the issue in detail, including: | ||
1. What actions led to the issue? | ||
2. What did you expect to happen? | ||
3. What actually happened? | ||
4. If possible, attach screenshots or videos demonstrating the problem. | ||
placeholder: | | ||
1. I clicked on... | ||
2. I expected the page to... | ||
3. Instead, I saw... | ||
4. [Attach screenshots/videos if available] | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: 'Additional Context (Optional)' | ||
description: | | ||
Provide any extra details, such as: | ||
- Related links. | ||
- Previous occurrences of this issue. | ||
- Workarounds you have tried. | ||
placeholder: 'This issue also happened on [link].' | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: Feature Request | ||
description: Suggest a new idea or enhancement for the IFRC GO project. | ||
title: "[Feature]: " | ||
labels: ['type: feature-request'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for suggesting a new feature! | ||
Please provide as much detail as possible to help us understand and evaluate your idea. | ||
Before submitting, please search our issue tracker to ensure this isn’t a duplicate request. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Feature Description | ||
description: | | ||
Describe your feature request in detail, including: | ||
- What the feature is. | ||
- Why it’s needed and how it will improve the project. | ||
- How it will benefit users (e.g., "As a user, I want to [do something] so that [desired outcome]."). | ||
placeholder: | | ||
As a user, I want to filter search results by date so that I can quickly find recent information. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional Context | ||
description: | | ||
Provide any extra details or supporting information, such as: | ||
- Links to references or related resources. | ||
- Examples from other projects or systems. | ||
- Screenshots, mockups, or diagrams. | ||
*Tip: You can attach files by clicking here and dragging them in.* | ||
placeholder: | | ||
Here’s a link to a similar feature in another project: [link]. | ||
I’ve also attached a mockup of what this could look like. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: Epic | ||
description: Track a larger initiative with multiple related tasks and deliverables for IFRC GO project. | ||
title: "[Epic]: " | ||
labels: ['type: epic'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Epic Overview | ||
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. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Epic Summary | ||
description: | | ||
Provide a clear and concise summary of the epic. | ||
- What is this epic about? | ||
- What problem does it solve or what goal does it achieve? | ||
- How does it align with the project’s objectives? | ||
placeholder: | | ||
Example: | ||
This epic focuses on implementing a new feature. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional Context or Resources | ||
description: | | ||
Provide any additional information, links, or resources that will help the team understand and execute this epic. | ||
placeholder: | | ||
Examples: | ||
- Link to design mockups: [link] | ||
- Technical specs document: [link] | ||
- Reference to similar features: [link] | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,27 @@ | ||
## Addresses: | ||
- XXX | ||
## Summary | ||
Provide a brief description of what this PR addresses and its purpose. | ||
|
||
## Depends on: | ||
- XXX | ||
## Addresses | ||
- Issue(s): _List related issues or tickets._ | ||
|
||
## Depends On | ||
- Other PRs or Dependencies: _List PRs or dependencies this PR relies on._ | ||
|
||
## Changes | ||
- Detailed list or prose of changes | ||
- Breaking changes | ||
- Changes to configurations | ||
|
||
## This PR doesn't introduce: | ||
- [ ] typos | ||
- [ ] conflict markers | ||
- [ ] unwanted comments | ||
- [ ] temporary files, auto-generated files or secret keys | ||
- [ ] `console.log` meant for debugging | ||
- [ ] codegen errors | ||
## This PR Ensures: | ||
- [ ] No typos or grammatical errors | ||
- [ ] No conflict markers left in the code | ||
- [ ] No unwanted comments, temporary files, or auto-generated files | ||
- [ ] No inclusion of secret keys or sensitive data | ||
- [ ] No `console.log` statements meant for debugging | ||
- [ ] `pnpm lint` runs without errors | ||
- [ ] `pnpm typecheck` passes (no type errors) | ||
- [ ] `pnpm knip` passes | ||
- [ ] `pnpm build` completes successfully | ||
|
||
## Additional Notes | ||
_Optional: Add any other relevant context, screenshots, or details here._ |