There are various ways you can contribute to the GAME SDK, whether it's fixing bugs, adding new plugins, or improving the documentation.
- Fork the repository and clone it to your local machine.
- Create a Branch for your changes.
- Make Changes to address the issue or add the feature.
- Ensure Compliance with the relevant contribution requirements:
- For general PRs, follow the default PR template.
- For plugin contributions, ensure your PR follows the plugin PR template.
- Commit with a message that clearly explains your change.
- Push the branch to your fork and submit a pull request.
- Label the pull request appropriately based on the label definitions.
If you are contributing to the core SDK, ensure the following:
- The code is well-documented.
- Your PR follows the default PR template.
- Screenshots, video demonstrations, or logs showcasing the changes are included (if applicable).
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. - Your PR follows the plugin PR template.
- Screenshots, video demonstrations, or logs showcasing the plugin functionality are included (if applicable).
- Open an issue in the Issues tab and tag it as a
bug
.
- Open an issue in the Issues tab and tag it as an
enhancement
.
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.