-
Notifications
You must be signed in to change notification settings - Fork 89
[Chore] Add PR Templates #80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,4 @@ | ||
| Click the `Preview` tab and select a PR template: | ||
|
|
||
| - [Default Template](?expand=1&template=default.md) | ||
| - [Plugin](?expand=1&template=plugin.md) |
This file contains hidden or 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,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 |
This file contains hidden or 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,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. |
This file contains hidden or 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,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) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.