Skip to content

[Docs] Update Contribution Guide #105

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.

Sign up for GitHub

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
celesteanglm merged 1 commit into from
Mar 21, 2025
Merged

[Docs] Update Contribution Guide #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 28 additions & 8 deletions CONTRIBUTION_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,41 @@ There are various ways you can contribute to the GAME SDK, whether it's fixing b
1. **Fork** the repository and clone it to your local machine.
2. **Create a Branch** for your changes.
3. **Make Changes** to address the issue or add the feature.
4. **Commit** with a message that clearly explains your change.
5. **Push** the branch to your fork and submit a pull request.
6. **Label** the pull request appropriately based on the [label definitions](#label-definitions)

4. **Ensure Compliance** with the relevant contribution requirements:
- For **general PRs**, follow the [default PR template](./.github/PULL_REQUEST_TEMPLATE/default.md).
- For **plugin contributions**, ensure your PR follows the [plugin PR template](./.github/PULL_REQUEST_TEMPLATE/plugin.md).
5. **Commit** with a message that clearly explains your change.
6. **Push** the branch to your fork and submit a pull request.
7. **Label** the pull request appropriately based on the [label definitions](#label-definitions).

### General Contribution Guidelines
If you are contributing to the core SDK, ensure the following:
- The code is well-documented.
- Your PR follows the [default PR template](./.github/PULL_REQUEST_TEMPLATE/default.md).
- Screenshots, video demonstrations, or logs showcasing the changes are included (if applicable).

### Plugin Contribution Guidelines
If you are adding a new plugin, ensure the following:
- A `README.md` file exists in the plugin root directory and includes:
- Installation instructions
- Usage examples with code snippets
- List of features and capabilities
- Troubleshooting guide (if applicable)
- Contribution guidelines (if applicable)
- 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).
- Your PR follows the [plugin PR template](./.github/PULL_REQUEST_TEMPLATE/plugin.md).
- Screenshots, video demonstrations, or logs showcasing the plugin functionality are included (if applicable).

### Reporting Bugs
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-python/issues) tab and tag it as a `bug`.

### Suggesting Enhancements
- Open an issue in the [Issues](https://github.com/your-username/my-project/issues) tab and tag it as an `enhancement`.
- Open an issue in the [Issues](https://github.com/game-by-virtuals/game-python/issues) tab and tag it as an `enhancement`.

## Label Definitions

Please tag issues and pull requests appropriately, based on the definition below:
- **plugin**: A plugin contribution.
- **bug**: A problem that needs fixing.
- **enhancement**: A requested enhancement.
- **help wanted**: A task that is open for anyone to work on.
- **documentation**: Documentation changes.
- **documentation**: Documentation changes.