-
Notifications
You must be signed in to change notification settings - Fork 71
/
CONTRIBUTING.md
42 lines (23 loc) · 1.82 KB
/
CONTRIBUTING.md
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
## How to contribute to ThorsSerializer
#### **Did you find a bug?**
* [Open an Issue](https://github.com/Loki-Astari/ThorsSerializer/issues/new).
Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
#### **Did you write a patch that fixes a bug?**
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
* Make sure it build localy with no errors.
./configure --disable-binary
make
#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
* Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of ThorsSerializer will generally not be accepted.
#### **Do you intend to add a new feature or change an existing one?**
* [Open an Issue](https://github.com/Loki-Astari/ThorsSerializer/issues/new).
#### **Do you have questions about the source code?**
* Check the internal [documentation](https://lokiastari.com/ThorsSerializer/)
* If this does not resolve your question [Open an Issue](https://github.com/Loki-Astari/ThorsSerializer/issues/new).
#### **Do you want to contribute to the ThorsSerializer documentation?**
* Documentation files can be found in [/docSource/source/package/](https://github.com/Loki-Astari/ThorsSerializer/tree/master/docSource/source/package) directory.
They are built with [andvari](https://github.com/Loki-Astari/andvari) using the [documentation theme](https://github.com/Loki-Astari/andvari-theme-documentation).
All documentation on hosted by github via [docs](https://lokiastari.com/ThorsSerializer/)
Thanks! :heart: :heart: :heart:
Loki Astari