loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'update-contributing' into dev

Browse Source
This commit is contained in:
Oliver Hamlet
2017-02-11 18:36:58 +00:00
parent 97bdbd9598 e53a1aaf7b
commit 0dbdadf5ab
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+11 -3
View File
@@ -1,7 +1,7 @@
Contributing To LOOT
====================
Contributing To the LOOT API
============================
A general guide to contributing to LOOT, may be found on [LOOT's website](https://loot.github.io/docs/contributing/How-To-Contribute). Information more specific to this repository is found here.
A general guide to contributing to LOOT may be found on [LOOT's website](https://loot.github.io/docs/contributing/How-To-Contribute). Information more specific to this repository is found here.
## Repository Branching Structure
@@ -19,6 +19,14 @@ Surprise pull requests aren't recommended because everything you touched may hav
When you do make a pull request, please do so from a branch which doesn't have the same name as they branch you're requesting your changes to be merged into. It's a lot easier to keep track of what pull request branches do when they're named something like `you:specific-cool-feature` rather than `you:master`.
### Adding Support For A New Language
If you're adding support for a new language, the LOOT API's source code must be updated to recognise it. The files and functions which must be updated are given below.
* In [language_code.h](include/loot/enum/language_code.h), append a value for the language to the `LanguageCode` enum.
* In [language.cpp](src/api/helpers/language.cpp), define the value for the constant you added, and update `Language::Language(LanguageCode code)` and `Language::codes({...})` to include lines for your language.
* In [localised_content.rst](docs/metadata/data_structures/localised_content.rst), add a row for your language to the Language Codes table.
## Code Style
LOOT's JavaScript uses a slightly tweaked version of the Airbnb style, and can be automatically linted by ESLint, so isn't covered here.