Skip to content

Commit

Permalink
feat: update pr and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
samshara committed Feb 19, 2025
1 parent bc7dda0 commit 53212be
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 25 deletions.
13 changes: 3 additions & 10 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ 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.
**Bug Report**
Please fill out the form below with as much detail as possible.
If the issue is visual, screenshots or videos are greatly appreciated.
**Please review [our guide on reporting bugs](https://github.com/IFRCGo/go-web-app/blob/develop/CONTRIBUTING.md#reporting-bugs) before opening a new issue.**
- type: input
attributes:
Expand Down Expand Up @@ -37,14 +38,6 @@ body:
validations:
required: true

- 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: textarea
attributes:
label: "Steps to Reproduce the Issue"
Expand Down
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/02_feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ body:
- type: markdown
attributes:
value: |
**Feature Request**
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.
**Please review [our guide on suggesting enhancements](https://github.com/IFRCGo/go-web-app/blob/develop/CONTRIBUTING.md#suggesting-enhancements).**
- type: textarea
attributes:
Expand Down
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/03_epic_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ 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.
**Epic**
Use this to define a large, overarching initiative.
**Please review [our guide on suggesting enhancements](https://github.com/IFRCGo/go-web-app/blob/develop/CONTRIBUTING.md#suggesting-enhancements).**
- type: textarea
attributes:
Expand Down
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://go-wiki.ifrc.org/en/home
about: Please consult the wiki to know more about IFRC GO.
30 changes: 18 additions & 12 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
## Summary

Provide a brief description of what this PR addresses and its purpose.

## Addresses
- Issue(s): _List related issues or tickets._

* Issue(s): *List related issues or tickets.*

## Depends On
- Other PRs or Dependencies: _List PRs or dependencies this PR relies 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

* Detailed list or prose of changes
* Breaking changes
* Changes to configurations

## 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
- [ ] All CI checks have passed

* \[ ] 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
* \[ ] All CI checks have passed

## Additional Notes
_Optional: Add any other relevant context, screenshots, or details here._

*Optional: Add any other relevant context, screenshots, or details here.*

0 comments on commit 53212be

Please sign in to comment.