Skip to content

Commit c2be557

Browse files
authored
Merge pull request game-by-virtuals#105 from game-by-virtuals/docs/yang-update-contribution-guide
[Docs] Update Contribution Guide
2 parents 9766697 + 40bb35b commit c2be557

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

CONTRIBUTION_GUIDE.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,41 @@ 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+
### General Contribution Guidelines
17+
If you are contributing to the core SDK, ensure the following:
18+
- The code is well-documented.
19+
- Your PR follows the [default PR template](./.github/PULL_REQUEST_TEMPLATE/default.md).
20+
- Screenshots, video demonstrations, or logs showcasing the changes are included (if applicable).
21+
22+
### Plugin Contribution Guidelines
23+
If you are adding a new plugin, ensure the following:
24+
- A `README.md` file exists in the plugin root directory and includes:
25+
- Installation instructions
26+
- Usage examples with code snippets
27+
- List of features and capabilities
28+
- Troubleshooting guide (if applicable)
29+
- Contribution guidelines (if applicable)
30+
- 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).
31+
- Your PR follows the [plugin PR template](./.github/PULL_REQUEST_TEMPLATE/plugin.md).
32+
- Screenshots, video demonstrations, or logs showcasing the plugin functionality are included (if applicable).
33+
1334
### Reporting Bugs
1435
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-python/issues) tab and tag it as a `bug`.
15-
36+
1637
### Suggesting Enhancements
17-
- Open an issue in the [Issues](https://github.com/your-username/my-project/issues) tab and tag it as an `enhancement`.
38+
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-python/issues) tab and tag it as an `enhancement`.
1839

1940
## Label Definitions
20-
2141
Please tag issues and pull requests appropriately, based on the definition below:
2242
- **plugin**: A plugin contribution.
2343
- **bug**: A problem that needs fixing.
2444
- **enhancement**: A requested enhancement.
2545
- **help wanted**: A task that is open for anyone to work on.
26-
- **documentation**: Documentation changes.
46+
- **documentation**: Documentation changes.

0 commit comments

Comments
 (0)