summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStoabrogga <38475780+Stoabrogga@users.noreply.github.com>2019-11-01 17:49:34 +0100
committerStefano Borzì <stefanoborzi32@gmail.com>2019-11-01 17:49:34 +0100
commit3cf921a3a369964ba37d83b400d9c6b75dbea0d6 (patch)
tree456d141571efdbb864f685cd6d63e4e40d2e278c /docs
parent339e9324e7f6e5bf4a25805868e889c84450948e (diff)
downloadwiki-3cf921a3a369964ba37d83b400d9c6b75dbea0d6.tar.gz
wiki-3cf921a3a369964ba37d83b400d9c6b75dbea0d6.tar.bz2
wiki-3cf921a3a369964ba37d83b400d9c6b75dbea0d6.zip
Update "How-to-create-a-PR" and "Installation" (#139)
Diffstat (limited to 'docs')
-rw-r--r--docs/How-to-create-a-PR.md11
-rw-r--r--docs/Installation.md4
2 files changed, 11 insertions, 4 deletions
diff --git a/docs/How-to-create-a-PR.md b/docs/How-to-create-a-PR.md
index 8c8077b..218a1c0 100644
--- a/docs/How-to-create-a-PR.md
+++ b/docs/How-to-create-a-PR.md
@@ -112,12 +112,19 @@ git add data/sql/updates/pending_db_world/rev_XXXXXXXXXXXX.sql
### 6. Commit & Push your changes
-First of all, commit your changes using:
+First of all make sure to use the AC commit template (this should only be necessary once):
+```
+git config --local commit.template ".git_commit_template.txt"
+```
+
+Then commit your changes using:
```
-git commit -m "fix: write a short commit message here"
+git commit
```
+You are then prompted to specify an appropriate commit message (please follow the format guidelines here).
+
Now it's time to push them remotely.
If you use the `git push` command for the first time in this branch,
git will ask to specify which remote branch you want to push to.
diff --git a/docs/Installation.md b/docs/Installation.md
index d12800a..5ee2fc8 100644
--- a/docs/Installation.md
+++ b/docs/Installation.md
@@ -54,10 +54,10 @@ At this point, you must be in your "build/" directory.
**Note2**: in case you use a non-default package for `clang`, you need to replace it accordingly. For example, if you installed `clang-6.0` then you have to replace `clang` with `clang-6.0` and `clang++` with `clang++-6.0`
```
-cmake ../ -DCMAKE_INSTALL_PREFIX=$HOME/azeroth-server/ -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DTOOLS=0 -DSCRIPTS=1
+cmake ../ -DCMAKE_INSTALL_PREFIX=$HOME/azeroth-server/ -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DTOOLS=0 -DSCRIPTS=1 -DWITH_WARNINGS=1 -DCMAKE_C_FLAGS="-Werror" -DCMAKE_CXX_FLAGS="-Werror"
```
-Then, replacing `4` with the number of threads that you want to execute, type:
+Then, replacing `6` with the number of threads that you want to execute, type:
```
make -j 6