You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTION_GUIDE.md
+22-8Lines changed: 22 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,21 +6,35 @@ There are various ways you can contribute to the GAME SDK, whether it's fixing b
6
6
1.**Fork** the repository and clone it to your local machine.
7
7
2.**Create a Branch** for your changes.
8
8
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
+
13
28
### Reporting Bugs
14
29
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-python/issues) tab and tag it as a `bug`.
15
-
30
+
16
31
### 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-python/issues) tab and tag it as an `enhancement`.
18
33
19
34
## Label Definitions
20
-
21
35
Please tag issues and pull requests appropriately, based on the definition below:
22
36
-**plugin**: A plugin contribution.
23
37
-**bug**: A problem that needs fixing.
24
38
-**enhancement**: A requested enhancement.
25
39
-**help wanted**: A task that is open for anyone to work on.
0 commit comments