1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
You can contribute in several ways to AzerothCore:
- [commenting an open issue](Contribute#how-to-comment-an-issue)
- [opening an issue](Contribute#how-to-open-an-issue)
- [testing a pull request](How-to-test-a-PR)
- [testing DB-only changes](How-to-test-DB-only-changes)
- [creating a pull request](Contribute#how-to-create-a-pull-request)
- [improving our wiki](Contribute#improve-the-wiki)
## General information
To contribute, you obviously need a github account.
## How to comment an issue
You can help much by checking the [issues](https://github.com/azerothcore/azerothcore-wotlk/issues) and joining their discussions.
One thing you can do is to update your core and check if the issue is still valid on your revision, then you can write a comment **including the commit hash**.
## How to open an issue
Important things to do before reporting a bug:
**1) Update your core to the latest AzerothCore revision and check whether the bug is still there**
**2) Search among the [issues](https://github.com/azerothcore/azerothcore-wotlk/issues) to check if someone has already reported the bug, in that case you have just to comment the issue to confirm the bug (including your core revision)**
If **(and only if)** the bug hasn't been reported yet, you can [open an issue](https://github.com/azerothcore/azerothcore-wotlk/issues/new) and include:
- the **description of the bug**, including any useful **links** and **IDs/GUIDs/names** of any related entities (NPCs, spells, gameobjects, etc..)
- the **core revision (commit hash)** of the AzerothCore you are running on, **do not write just "latest version"** even if you have just updated your core
- if it is about a build problem, it would be useful to know also your **operating system** and **compiler version**
## How to test a Pull Request
- Read [How to test a PR](How-to-test-a-PR).
## How to create a Pull Request
Official GitHub tutorial [here](https://help.github.com/articles/creating-a-pull-request/).
In order to create a Pull Request (PR), you have to fork the [AzerothCore repository](https://github.com/azerothcore/azerothcore-wotlk) (via your web browser, using the top-right Fork button) and clone your fork locally with `git clone https://github.com/YOUR_USERNAME/azerothcore-wotlk.git`.
If you already have a local fork, remember to [sync it](Syncing-your-fork) before creating a new Pull Request to avoid conflicts.
Open a terminal and move to your local clone of the fork, then create a new branch by typing:
`git checkout -b my-branch` (Note: **my-branch** is an arbitrary name, choose whatever you want here)
Now add your changes to the code.
**IMPORTANT:** If you are going to add some database contents or structure changes, read [how to deal with SQL files](Dealing-with-SQL-files) first.
Then you can commit your changes and push them:
```
## Select all your modified files
git add .
## Commit your changes (you can simply type "git commit -v" too)
git commit -v -m "Commit message here"
## origin = your git remote (the url of your fork)
git push origin my-branch
```
Now via web open your repository, switch to your new branch and click on _New pull request_ and compare our original repo/master branch with your fork/my-branch.
**IMPORTANT:** remember to create **one separate PR for each feature/fix (use a separate branch for each PR)**
### Describe the testing steps
Please describe how other users should test your PR. This way people can easily check it and it will be faster to be merged.
### Giving credit to the author of code
If you want to submit code written by someone else, you can give credits to the author when you commit:
`git commit --author="AuthorName <authoremail@address.com>" -am "Commit message here"`
Update: unfortunately, when merging a PR by squashing the commit, GitHub automatically sets the author of the resulting commit as the person who opened the PR. Because of this reason, please mention the original author (and commit, if applicable) in the PR description.
## Improve the Wiki
Do you want to improve or add a page to our wiki? Good! Let's discuss it using [our chat](https://discord.gg/PaqQRkd).
|
