These guidelines provide information on the best practices on how to contribute to this repository. Following this guidelines will fasten the review of pull requests.
The following rules for pull requests apply:
- Create an issue for your PR
- Only one PR for a specific issue
- Do not commit unrelated code to your PR
- Provide specific explanations about your PR
- If required, provide answers to possible questions
- Try not to put too much code into a single commit, separate as possible
- Follow the existing style of code
Contributions must comply with OpenSource definitions and need to be compatible with the projects license. Also some principles of selfhosted must be respected. These include (but are not limited to) data privacy.
If you have any questions before submitting a PR, you can first create an issue to get answers.
HortusFox is built with the Asatru PHP Framework. The documentation is located in the /doc directory.
There is also an online documentation available.
Submitting new localizations helps to bring the project to a broader audience. Language files are located in the /app/lang directory.
Steps to create a new language
- Create a new folder with your language and add the following files (copy them from
/app/en). As an example we usedeas german language.
/app/lang/de/app.php
/app/lang/de/errors.php
/app/lang/de/tb.php
- Translate the original phrases into your desired language. Note that expressions in moustache-brackets are placeholders for variables.
return [
//...
'some_expression' => 'Here comes the translated phrase',
'another_expression' => 'The following expression is a variable placeholder: {var}.'
//...
];Users can now select the new language via their preferences and you can also set the language as default in the admin dashboard.