Skip to content

Commit f2aa30b

Browse files
authored
Merge pull request game-by-virtuals#80 from game-by-virtuals/chore/yang-add-pr-templates
[Chore] Add PR Templates
2 parents d8aeb1d + 0d4a7d1 commit f2aa30b

File tree

4 files changed

+94
-0
lines changed

4 files changed

+94
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Click the `Preview` tab and select a PR template:
2+
3+
- [Default Template](?expand=1&template=default.md)
4+
- [Plugin](?expand=1&template=plugin.md)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Summary
2+
3+
One-liner - what does this change?
4+
5+
## Changes
6+
7+
(Answer where applicable)
8+
9+
- Important links (Jira/Notion/GitHub Issues):
10+
- Why this PR is needed?
11+
- What does this add?
12+
- What does this deprecate?
13+
- What does this improve?
14+
15+
## Related Changes
16+
17+
- Does this have a dependant PR? Eg. link to original PR if this is a bug fix PR.
18+
19+
(Use table to list all related PRs if done in parts)
20+
21+
| Description | PR |
22+
| --- | --- |
23+
| [Part 1] This PR | ⬅️ |
24+
| [Part 2] Another PR | link |
25+
| [Part 3] Another PR | link |
26+
27+
## Dev Testing
28+
29+
(Include where applicable)
30+
31+
- Screenshots
32+
- Video Recordings
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Summary
2+
3+
One-liner – What does this plugin contribution add or change?
4+
5+
## Links
6+
7+
- Plugin documentation:
8+
- Issue link (if applicable):
9+
- Other useful links:
10+
11+
## Plugin Documentation Checklist
12+
13+
- README Validation
14+
- [ ] Clear installation instructions
15+
- [ ] Usage examples with code snippets
16+
- [ ] List of features and capabilities
17+
- [ ] Troubleshooting guide (if applicable)
18+
- [ ] Contribution guidelines (if applicable)
19+
20+
- Metadata Validation
21+
- [ ] Complete metadata provided in reference to [plugin metadata template](../.././plugins/plugin_metadata_template.yml)
22+
23+
## Dev Testing
24+
25+
(Include where applicable)
26+
27+
- Screenshots/GIFs
28+
- Video Demonstrations
29+
- Logs or Console Outputs
30+
- Testing steps for the plugin
31+
32+
## Additional Notes
33+
34+
- Any considerations for future updates or enhancements.
35+
- Known issues or limitations with this plugin contribution.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# General Information
2+
plugin_name: "" # Name of the plugin
3+
author: "" # Author and team name
4+
logo_url: "" # URL to the author photo or team logo (512x512 recommended)
5+
release_date: "" # Release date (DD-MM-YYYY)
6+
7+
# Description
8+
short_description: "" # One-liner description for listings
9+
detailed_description: "" # Full description with features and benefits
10+
11+
# Media & Assets
12+
plugin_logo_url: "" # URL to the plugin logo (512x512 recommended) (if any or fallback to logo_url)
13+
screenshots: # List of screenshots showcasing the plugin
14+
- "" # e.g., "https://example.com/screenshot1.png"
15+
- ""
16+
demo_video_url: "" # Link to a demo or walkthrough video (if available)
17+
documentation_url: "" # Link to the plugin's official documentation (if available)
18+
changelog_url: "" # Link to the changelog (if maintained)
19+
20+
# Contact & Support
21+
x_account_handle: "" # X (formerly known as Twitter) account handle (ie: @GAME_Virtuals)
22+
support_contact: "" # Email or Slack/Discord link for user support
23+
community_link: "" # Forum or community link (if any)

0 commit comments

Comments
 (0)