summaryrefslogtreecommitdiff
path: root/docs/best-practices.md
diff options
context:
space:
mode:
authorFrancescoBorzi <borzifrancesco@gmail.com>2019-03-04 17:28:48 +0100
committerFrancescoBorzi <borzifrancesco@gmail.com>2019-03-04 17:28:48 +0100
commitfecdf407f0c5d8685802a142f1834603fabfb94e (patch)
tree20f3f06da00b5ab7deff8c2a0813bec5220edd4d /docs/best-practices.md
parentdce37f458a8803742893549586adcbf6c7c0ff04 (diff)
parent44c4babac6b6607abda4729a6a2c39ca3434f86c (diff)
downloadwiki-fecdf407f0c5d8685802a142f1834603fabfb94e.tar.gz
wiki-fecdf407f0c5d8685802a142f1834603fabfb94e.tar.bz2
wiki-fecdf407f0c5d8685802a142f1834603fabfb94e.zip
Merge branch 'master' of https://github.com/azerothcore/wiki
Diffstat (limited to 'docs/best-practices.md')
-rw-r--r--docs/best-practices.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/best-practices.md b/docs/best-practices.md
new file mode 100644
index 0000000..a9f19af
--- /dev/null
+++ b/docs/best-practices.md
@@ -0,0 +1,35 @@
+# Best Practices
+
+A collection of best practices to use AzerothCore.
+
+
+## Custom changes
+
+- **NEVER** add custom changes to the AzerothCore sources. [Create modules](http://www.azerothcore.org/wiki/Create-a-Module) instead.
+
+If you need new hooks to implement your custom changes into modules, feel free to send a PR that implements them.
+
+Reasons:
+
+1. keeping your base source code clean will make it easier for you to update it
+2. keeping your customizations into modules will allow you to easily enable/disable them to troubleshoot any potential issue
+3. modularized software is much easier to maintain
+
+
+## Pull Requests (PR)
+
+- [Sync your fork](http://www.azerothcore.org/wiki/Syncing-your-fork) before opening a PR
+
+Reasons:
+
+1. Helps preventing merge conflicts
+2. You will implement (and test) your changes as they were applied to latest master version
+
+- **NEVER** push changes to the `master` branch. Aalways your `master` branch clean.
+
+When you create a new PR, do `git checkout master` and create a new branch using `git checkout -b new-branch`.
+
+Reasons:
+
+1. This will allow you to create multiple PRs that are independent from each other
+2. This will allow you to easily update your branches with latest master by first synching your fork and then merging `master` into your PR branches.