aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAokromes <Aokromes@users.noreply.github.com>2015-05-28 19:48:47 +0200
committerAokromes <Aokromes@users.noreply.github.com>2015-05-28 19:48:47 +0200
commitadb5dbed8008b1927c3fe12a3548d2f464103275 (patch)
treed783164fb15d9c6075012e31407c96d423cb2341 /CONTRIBUTING.md
parentfd660d725d62f56ab20e5bd170dc2614e202d050 (diff)
Engrish to english CONTRIBUTING.md
By thumsoul and clarify some things.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md55
1 files changed, 39 insertions, 16 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 99fb588c1cf..01e941cc465 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,41 @@
# Contributing
-Want to contribute? Great!
+So, you want to contribute? Great!
+Contributing is not only about creating fixes, but also reporting bugs. Before reporting a bug, please make sure to use the latest core and database revision.
+
+
+Issues
+======
+
+Read [this](http://www.trinitycore.org/f/topic/37-the-trinitycore-issuetracker-and-you/) before creating a ticket.
+If you have problems with TrinityCore instalation, read [this](http://www.trinitycore.org/f/topic/1518-trouble-with-your-trinity-install-readme-1st-faqs/)
+
+Mandatory things when creating a ticket:
+========================================
+
+- Branch
+- commit hash (if you get something like TrinityCore rev. unknown 1970-01-01 00:00:00 +0000 (Archived branch) (Win64, Release), please read this [post](http://www.trinitycore.org/f/topic/345-howto-properly-install-git-on-windows-fix-trinitycore-rev-1970-01-01-000000-0000/) or clone this repository instead downloading the source code.
+- entries of affected creatures / items / quests with a link to the relevant wowhead page.
+- clear title and description of the bug - if your english is very bad, please use google translate or yandex to translate to english and include one text in your native language.
+
+When reporting a crash, you MUST compile in debug mode because release dumps are useless (not enough information) - if you don't know how to compile in debug, read [this](http://www.trinitycore.org/f/topic/1518-trouble-with-your-trinity-install-readme-1st-faqs/#entry47672)
+
+We sugest the title and body to have the next style:
+
+DB/Quest: The Collapse
+
+4.3.4 branch
+hash 63f96a282307
+The quest "The Collapse" http://www.wowhead.com/quest=11706 lacks final event.
+
+Creating Pull Requests:
+=======================
1. Fork it.
-2. Create a branch (`git checkout -b fixes`)
+2. Create a branch (`git checkout -b fixes`) (Note: fixes is an arbitrary name, choose whatever you want here)
3. Commit your changes (`git commit -am "Added Snarkdown"`)
4. Push to the branch (`git push origin fixes`)
-5. Open a [Pull Request][1]
+5. Open a Pull Request
When creating patches read:
@@ -14,10 +43,12 @@ When creating patches read:
- [WDB Fields](http://www.trinitycore.org/f/topic/58-wdb-fields/)
- [Git Squash](https://ariejan.net/2011/07/05/git-squash-your-latests-commits-into-one/)
-We suggest you to create one branch for each `C++` based fix: on that way you can continue creating more fixes without having to wait to get one pull request merged.
-For the `SQL` files of `C++` based fixes the naming schema is: `YYYY_MM_DD_i_database_description.sql`, where `YYYY_MM_DD` is the date of the fix, `i_database` is the *ith* sql created that day for `database`.
+
+We suggest that you create one branch for each C++ based fix: this will allow you to create more fixes without having to wait for your pull request to be merged.
+For the SQL files coming with C++ based fixes the naming schema is `YYYY_MM_DD_i_database.sql`, where `YYYY_MM_DD` is the date of the fix, `i_database` is the *ith* sql created that day for `database`.
When doing changes to `auth` or `characters` database remember to update the base files (`/sql/base/*`).
-For SQL only fixes [create a ticket](https://github.com/TrinityCore/TrinityCore/issues/new).
+For SQL only fixes, please [create a ticket](https://github.com/TrinityCore/TrinityCore/issues/new).
+Since it's very unlikely that your Pull Request will be merged on the day that you open it, please name the files with an impossible date to avoid merging issues ie: 2015_13_32_00_world.sql
Wiki
====
@@ -27,13 +58,6 @@ The wiki is located at [http://trinitycore.info](http://trinitycore.info).
You are welcome to create an account and help us improve and extend the wiki.
-Issues
-======
-
-Read [this](http://www.trinitycore.org/f/topic/37-the-trinitycore-issuetracker-and-you/) before creating a ticket.
-If you have problems with TrinityCore instalation, read http://www.trinitycore.org/f/topic/1518-trouble-with-your-trinity-install-readme-1st-faqs/
-
-
Requirements
============
@@ -44,7 +68,6 @@ MySQL ≥ 5.1.0
CMake ≥ 2.8.11.2 / 2.8.9 (Windows / Linux)
OpenSSL ≥ 1.0.0
GCC ≥ 4.7.2 (Linux only)
-MS Visual Studio ≥ 12 (2013) (Windows only)
+MS Visual Studio ≥ 12 (2013) Update 4 (Windows only)
-In case you choose Linux, we recommend to use Debian 7, it's the Linux we use to test compilations.
-Remember 4.3.4 branch is alpha, only intended for development, we don't recomend this branch to run a server.
+If you choose Linux, we recommend to use Debian 8, since it's the Linux that we use to test compilations.