Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 2.93 KB
Raw

Contributing to Torsion

We're happy that you have chosen to contribute to the Torsion project.

To organize these efforts we have written this simple guide to help you.

Please read this document completely before contributing.

How To Contribute

If you are looking for ways to help you should start by looking at the Help Wanted tasks. Please let us know if you plan to work on an issue so that others are not duplicating work.

The Torsion project follows standard GitHub flow. You should learn and be familiar with how to use Git, how to create a fork of Torsion, and how to submit a Pull Request.

Project maintainers and contributors will review your changes and provide constructive feedback to improve your submission.

Once satisfied that your changes are good for Torsion we will merge it.

Quick Guidelines

Here are a few simple rules and suggestions to remember when contributing to Torsion.

  • ‼️ NEVER commit code that you didn't personally write.
  • PLEASE try keep your PRs focused on a single topic and of a reasonable size or we may ask you to break it up.
  • DO NOT surprise us with new APIs or big new features. Open an issue to discuss your ideas first.
  • DO NOT reorder code as it makes it difficult to compare code changes in a PR.
  • DO try to follow the existing code style of the file you're changing.
  • DO NOT send PRs for code style changes or make code changes just for the sake of style.
  • PLEASE keep a civil and respectful tone when discussing and reviewing contributions.
  • PLEASE tell others about Torsion and your contributions via social media.

Licensing

The Torsion project is under the MIT License. See the LICENSE.txt file for more details. Third-party libraries used by Torsion are under their own licenses. Please refer to those libraries for details on the license they use.

We accept contributions in "good faith" that it isn't bound to a conflicting license. By submitting a PR you agree to distribute your work under the Torsion license and copyright.

To this end when submitting new files include the following in the header if appropriate:

// Torsion TorqueScript IDE - Copyright (C) Sickhead Games, LLC
// This file is subject to the terms and conditions defined in
// file 'LICENSE.txt', which is part of this source code package.

Need More Help?

If you need help please ask questions in a GitHub issue or in our live Gitter room.

Thanks for reading this guide and helping make Torsion great!

  • ❤️ Sickhead