Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.13 KB
Raw

Contributing to Turbo Demo Games

We're excited that you're interested in contributing to the Turbo Demo Games repository! This document outlines the process for contributing.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your account.

  2. Create a New Branch: Create a new branch for your contribution.

Updating a Demo

  1. Update the Demo Game:

    • Make changes to the demo game's code or assets.
    • You may also make a new demo game if you want.

  2. Test Your Changes:

    • Ensure the demo game runs smoothly.
    • Ensure the demo game is free of major bugs.

  3. Submit a Pull Request:

    • Ensure your PR targets the main branch of the original repository.
    • Add a good description of your changes and why you made them.

Submitting a "Built with Turbo" Game

  1. Develop Your Game:

    • Make sure it showcases specific features or capabilities of the Turbo engine.
    • Include a README in your demo's directory explaining the game and its purpose.

  2. Test Your Game:

    • Ensure your game runs smoothly.
    • Ensure your game is free of major bugs.

  3. Submit a Pull Request:

    • Ensure your PR targets the main branch of the original repository.
    • Add your entry under the "Built with Turbo" section of README.md
    • Use the following markdown as a template.
### Your Game Name

![a screenshot of your game](https://... | height=100)

A clear description of your demo and what it showcases.

[🎮 play](https://...) / [🎥 demo](https://...) / [💻 repo](https://...)

Guidelines

  • Code Quality: Write clean, commented, and maintainable code.
  • Assets: Use free or original assets and provide proper attribution if required.
  • Documentation: Include a README with your demo explaining its purpose and any unique aspects.

Review Process

Our maintainers will review your submission. They may suggest changes or improvements to ensure the demo aligns with the quality and goals of the repository.

Thank you for contributing to Turbo Demo Games! Your efforts help make Turbo a richer and more versatile game development tool.

Happy Game Making!