From d73ddc5d7777391ec975d396b3e699065cd97d6c Mon Sep 17 00:00:00 2001 From: Daniel Buckmaster Date: Mon, 27 Oct 2014 17:22:50 +1100 Subject: [PATCH 1/3] Create CONTRIBUTING.md --- CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..db625977f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Torque 3D contribution guidelines + +So you want to help TOrque out by contributing to the repo? That's awesome! +We just ask that you'd give this document a quick read to get yourself familiar with the process. +Do you want to [request a feature](#request-a-feature)? +Create a [pull-request](#create-a-pull-request) to contribute your own code to the engine? +[Report an issue](#report-an-issue) you've discovered? + +## Report an issue + +Before you report an issue with the engine, please [search](https://github.com/GarageGames/Torque3D/issues) and quickly make sure someone else hasn't obviously reported it. +If you're ont sure if it's the same issue, go ahead and comment on the issue! +Once you're certain you've found a new issue, hit the [big green button](https://github.com/GarageGames/Torque3D/issues/new) and please include the following information: + + * Your platform and compiler, if you're not using a precompiled binary + * Steps to reproduce the issue, if _at all_ possible + * If it's related to graphics, your GFX card and driver details. + +## Create a pull-request + +We ask that potential contributors read our [pull-request guidelines](http://torque3d.org/contribute/#pull-request-guide) before opening a PR. +Here's a quick guide to the branches in this repo that you might think of targeting a PR at: + +### The master branch + +The repository's `master` branch is where we make releases. +It's supposed to be stable at all times - or as stable as we can make it - and only gets updated when a new version comes out. +Any pull-requests to the master branch will have to be rejected - sorry :(. + +### The development branch + +The `development` branch is where most development happens. +It is the target for the next 'middle' version of the engine (the 6 in 3.6.1, for example). +This means we will add new features, and refactor code if it doesn't break existing games made with the engine _too_ much*. +Most pull requests to `development` can be accepted if we like your code - unless they would potentially break users' games. + +*How much is _too_ much is for the Steering Committee to decide. + +### The development-3.6 branch + +The `development-3.6` branch is where we will make bugfixes and small patches to the previous stable 'middle' version. +This branch is where the 'small' versions will be created - 3.6.2, 3.6.3, etcetera. +So if you have a bugfix or tiny enhancement that doesn't require anyone to change their game, it'd be best appreciated in this branch. + +### TLDR + +Don't make any PRs to `master`. +PR new features and large fixes/refactorings to `development`. +PR bugfixes to `development-3.6`. + +## Request a feature + +We ask that all feature requests be discussed in the [GarageGames forums](http://www.garagegames.com/community/forums), our [IRC channel](http://torque3d.wikidot.com/community:chat), or on our [UserVoice feature request voting page](https://garagegames.uservoice.com/forums/178972-torque-3d-mit/filters/top) before making an issue here. +If your idea is popular, we'll hear of it and probably make an issue ourselves, if we agree. + +Even better - don't request a feature, start working on it! +This engine isn't going to improve itself ;). From 8e1a323e181a6af090d26ac9df51bc25df4ada45 Mon Sep 17 00:00:00 2001 From: Daniel Buckmaster Date: Mon, 27 Oct 2014 17:25:26 +1100 Subject: [PATCH 2/3] Fixed typos. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db625977f..997d6782c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Torque 3D contribution guidelines -So you want to help TOrque out by contributing to the repo? That's awesome! +So you want to help Torque out by contributing to the repo? That's awesome! We just ask that you'd give this document a quick read to get yourself familiar with the process. Do you want to [request a feature](#request-a-feature)? Create a [pull-request](#create-a-pull-request) to contribute your own code to the engine? @@ -9,7 +9,7 @@ Create a [pull-request](#create-a-pull-request) to contribute your own code to t ## Report an issue Before you report an issue with the engine, please [search](https://github.com/GarageGames/Torque3D/issues) and quickly make sure someone else hasn't obviously reported it. -If you're ont sure if it's the same issue, go ahead and comment on the issue! +If you're not sure if it's the same issue, go ahead and comment on it! Once you're certain you've found a new issue, hit the [big green button](https://github.com/GarageGames/Torque3D/issues/new) and please include the following information: * Your platform and compiler, if you're not using a precompiled binary From 1e47b7bf4494e61968a257a9e1bf3f62482642b1 Mon Sep 17 00:00:00 2001 From: Daniel Buckmaster Date: Sun, 2 Nov 2014 08:04:12 +1100 Subject: [PATCH 3/3] Mention code style guidelines. --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 997d6782c..dd81cb739 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,7 @@ Once you're certain you've found a new issue, hit the [big green button](https:/ ## Create a pull-request We ask that potential contributors read our [pull-request guidelines](http://torque3d.org/contribute/#pull-request-guide) before opening a PR. +We also have some [code style guidelines](https://github.com/GarageGames/Torque3D/wiki/Code-Style-Guidelines). Here's a quick guide to the branches in this repo that you might think of targeting a PR at: ### The master branch