Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 1.61 KB
Raw

Contributing to GameDevTechStandards

Thanks for considering contributing to this project! Your input and expertise can make this a valuable resource for the game development community.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Style Guidelines
  5. Testing
  6. Submitting Changes

Code of Conduct

By participating in this project, you're expected to uphold our Code of Conduct. Please read Code_of_Conduct.md for details.

Getting Started

  • Fork the repository
  • Clone your fork locally
  • Create a new branch for your feature or fix

How to Contribute

  1. Documentation: Update or add new chapters in the Book/ directory.
  2. Validation Tools: Contribute to or improve the standalone validation tools in the Tools/ directory.
  3. Code Samples: Offer practical code examples to supplement the chapters.

Style Guidelines

  • Write in clear, simple English.
  • For code contributions, follow the established code style.

Testing

If you are contributing code, make sure to run the relevant tests to ensure everything is working as expected.

Submitting Changes

  1. Commit your changes in your feature branch.
  2. Push your branch to your fork on GitHub.
  3. Create a Pull Request targeting the main branch of the original repository.
  4. Address any review comments and push updates to your feature branch as needed.

Once your pull request is approved, it will be merged into the main codebase.

Thanks for taking the time to contribute!