|
1495
by Ted John
Create CONTRIBUTING.md |
1 |
# Contributing to OpenRCT2
|
2 |
Any contribution to OpenRCT2 is welcome and valued. Contributions can be in the form of bug reports, translation or code |
|
3 |
additions / changes. Please read this document to learn how to contribute as effectively as possible. If you have any |
|
4 |
questions or concerns, please ask in the [gitter](https://gitter.im/OpenRCT2/OpenRCT2) chat room. |
|
5 |
||
6 |
# Reporting bugs
|
|
7 |
To report a bug, ensure you have a GitHub account. Search the issues page to see if the bug has already been reported. |
|
8 |
If not, create a new issue and write the steps to reproduce. Upload a saved game if possible and this is very helpful |
|
|
1658
by Ted John
Update CONTRIBUTING.md |
9 |
for users to replicate the bug. Please state which version of the game you are running and where you downloaded it from, e.g. *openrct2.com develop 0.0.3 build 1255 (ec25b2f)*.
|
|
1495
by Ted John
Create CONTRIBUTING.md |
10 |
|
11 |
# Translation
|
|
12 |
Translation is managed in a separate repository, [OpenRCT2/Localisation](https://github.com/OpenRCT2/Localisation). |
|
13 |
You will find more information there. |
|
14 |
||
15 |
# Contributing code
|
|
16 |
## Steps
|
|
17 |
1. First, ensure you have a GitHub account and [fork](https://help.github.com/articles/fork-a-repo/) the OpenRCT2 repository. |
|
18 |
2. Create a new branch from develop (unless you are contributing to another) and commit your changes to that.
|
|
19 |
3. Submit a new [pull request](https://help.github.com/articles/using-pull-requests/). |
|
20 |
4. Wait for other users to test and review your changes.
|
|
21 |
||
22 |
## Credits
|
|
23 |
If you are contributing to OpenRCT2, please add your name to ```./contributors.md``` so that you can be credited for your |
|
24 |
work outside and inside the game. |
|
25 |
||
26 |
## Code hints
|
|
27 |
### Adding new strings
|
|
28 |
If you need to add a new localisable string to OpenRCT2, please add your new string entry to ```./data/language/english_uk.txt```. |
|
29 |
It is important that you only edit English (UK) in the OpenRCT2 repository as this is the base language that is used for |
|
30 |
translation to other languages. A separate repository OpenRCT2/Localisation is used for translation pull requests, and changes |
|
31 |
to that repository are merged with the OpenRCT2 main repository every night. When your pull request is merged, it is helpful |
|
32 |
to create a new issue in the OpenRCT2/Localisation repository about the new strings you have added. This notifies translators |
|
33 |
so that they can translate the new strings as quick as possible. Similarly if you change any existing string, it is more |
|
34 |
important that you create an issue as this can be more easily overlooked. |
|
35 |
||
36 |
When coding, please also add a string constant for your strings to ```./src/localisation/string_ids.h```. |
|
37 |
||
38 |
### Coding style / language
|
|
39 |
OpenRCT2 currently does not have a strict coding style. This will be implemented after the entire game is implemented and |
|
40 |
undergoes heavy refactoring. For now, it is recommended that you only write C files as the majority of the game is currenlty in |
|
41 |
C. Exceptions are to modules that have no direct relationship to original code such as the new software audio mixer, the |
|
42 |
HTTP integration and the Twitch integration. |