Skip to content

Commit 1f9b956

Browse files
committed
docs: update to latest changes
1 parent aadd3b7 commit 1f9b956

File tree

2 files changed

+31
-15
lines changed

2 files changed

+31
-15
lines changed

.github/PULL_REQUEST_TEMPLATE/plugin.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,16 @@ One-liner – What does this plugin contribution add or change?
1111
## Plugin Documentation Checklist
1212

1313
- 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)
14+
- [ ] `README.md` file exists in the plugin root folder
15+
- [ ] Clear installation instructions
16+
- [ ] Usage examples with code snippets
17+
- [ ] List of features and capabilities
18+
- [ ] Troubleshooting guide (if applicable)
19+
- [ ] Contribution guidelines (if applicable)
1920

2021
- Metadata Validation
21-
- [ ] Complete metadata provided in reference to [plugin metadata template](../.././plugins/plugin_metadata_template.yml)
22+
- [ ] `plugin_metadata.yml` file exists in the plugin root folder
23+
- [ ] Complete metadata provided in reference to [plugin metadata template](../.././plugins/plugin_metadata_template.yml)
2224

2325
## Dev Testing
2426

CONTRIBUTION_GUIDE.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,35 @@ There are various ways you can contribute to the GAME SDK, whether it's fixing b
66
1. **Fork** the repository and clone it to your local machine.
77
2. **Create a Branch** for your changes.
88
3. **Make Changes** to address the issue or add the feature.
9-
4. **Commit** with a message that clearly explains your change.
10-
5. **Push** the branch to your fork and submit a pull request.
11-
6. **Label** the pull request appropriately based on the [label definitions](#label-definitions)
12-
9+
4. **Ensure Compliance** with the relevant contribution requirements:
10+
- For **general PRs**, follow the [default PR template](./.github/PULL_REQUEST_TEMPLATE/default.md).
11+
- For **plugin contributions**, ensure your PR follows the [plugin PR template](./.github/PULL_REQUEST_TEMPLATE/plugin.md).
12+
5. **Commit** with a message that clearly explains your change.
13+
6. **Push** the branch to your fork and submit a pull request.
14+
7. **Label** the pull request appropriately based on the [label definitions](#label-definitions).
15+
16+
### Plugin Contribution Guidelines
17+
If you are adding a new plugin, ensure the following:
18+
- A `README.md` file exists in the plugin root directory and includes:
19+
- Installation instructions
20+
- Usage examples with code snippets
21+
- List of features and capabilities
22+
- Troubleshooting guide (if applicable)
23+
- Contribution guidelines (if applicable)
24+
- A `plugin_metadata.yml` file exists in the plugin root directory with complete metadata as per the [plugin metadata template](./plugins/plugin_metadata_template.yml).
25+
- Your PR follows the [plugin PR template](./.github/PULL_REQUEST_TEMPLATE/plugin.md).
26+
- Screenshots, video demonstrations, or logs showcasing the plugin functionality are included (if applicable).
27+
1328
### Reporting Bugs
14-
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-python/issues) tab and tag it as a `bug`.
15-
29+
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-node/issues) tab and tag it as a `bug`.
30+
1631
### Suggesting Enhancements
17-
- Open an issue in the [Issues](https://github.com/your-username/my-project/issues) tab and tag it as an `enhancement`.
32+
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-node/issues) tab and tag it as an `enhancement`.
1833

1934
## Label Definitions
20-
2135
Please tag issues and pull requests appropriately, based on the definition below:
2236
- **plugin**: A plugin contribution.
2337
- **bug**: A problem that needs fixing.
2438
- **enhancement**: A requested enhancement.
2539
- **help wanted**: A task that is open for anyone to work on.
26-
- **documentation**: Documentation changes.
40+
- **documentation**: Documentation changes.

0 commit comments

Comments
 (0)