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