Thanks for showing interest in contributing to DecAPI. While there are a handful of contributors, it is primarily by developed by one person right now and contributions are generally welcome.
Pull requests are welcome for new features, but ideally I'd like to discuss it via Discord or through issues before anything is implemented.
This document (CONTRIBUTING) is currently work in progress and may be missing some information.
Feel free to contact me via Discord, GitHub issues or my personal email if you have any questions.
The easiest way to contribute is by providing translations. You can see the currently available translations in the resources/lang directory of the project.
ISO 3166-1 alpha-2 codes are used for referring to languages.
DecAPI supports some basic translations for certain endpoints, but it's not implemented fully everywhere.
Most translations are provided by users of DecAPI.
There's some information about translations on the documentation website.
The project repository has a .editorconfig file that defines a few basic rules for how files should be formatted.
There are EditorConfig plugins for various editors that you can download to make your editor automatically format the files based on the .editorconfig file.
The following basic rules should apply and are already defined in the .editorconfig file:
- Indentation: 4 spaces - Sometimes referred to as "soft tabs"
- Newlines: Unix-style - Sometimes referred to as
LFor\n - Empty lines are fine as long as they're not excessive. They should not include any extra whitespace
- Lines should not have any trailing whitespace
- Exception: Markdown (
.md) files, where trailing whitespace might indicate a line break
- Exception: Markdown (
These formatting rules apply even if the file is not following is already, as there's a chance some of the files from early development have not been edited since .editorconfig was added.