2017-05-01 19:24:48 +00:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
Before you start working on a PR, contact us via IRC in #froxlor on Freenode or
|
|
|
|
|
the forum at https://forum.froxlor.org to get a clue whether someone else isn't
|
2018-12-04 09:52:49 +00:00
|
|
|
already working on it or if we don not want/need this certain change.
|
|
|
|
|
Of course, bugfixes are always welcome.
|
2017-05-01 19:24:48 +00:00
|
|
|
However, at this stage of the 0.9.x branch, we are not looking for new
|
|
|
|
|
features or refactoring, especially not the kind which requires changes to a
|
|
|
|
|
lot of files.
|
2018-12-04 09:52:49 +00:00
|
|
|
Please focus on our API based version 0.10.x (current master).
|
2017-05-01 19:24:48 +00:00
|
|
|
|
|
|
|
|
## Checklist
|
|
|
|
|
|
|
|
|
|
General rules for PRs are:
|
2022-04-28 18:48:00 +00:00
|
|
|
|
2017-05-01 19:24:48 +00:00
|
|
|
* Please save us all some trouble and unnecessary round-trips by _testing_ your
|
|
|
|
|
changes.
|
|
|
|
|
|
|
|
|
|
* Re-write your commit history to provide a CLEAN history!
|
|
|
|
|
|
|
|
|
|
* i.e. do not provide PRs which contain a commit that changes something,
|
|
|
|
|
the next changes it back, a third one changes it again, only a little
|
|
|
|
|
differently...
|
|
|
|
|
|
|
|
|
|
Thanks!
|
|
|
|
|
|
|
|
|
|
### Webserver changes
|
|
|
|
|
If you make changes to the functionality of webserver configuration, please
|
2018-12-04 09:52:49 +00:00
|
|
|
make sure your implementation covers all supported webservers.
|
2017-05-01 19:24:48 +00:00
|
|
|
|
|
|
|
|
### l10n
|
|
|
|
|
|
|
|
|
|
If you add new language strings, please make sure you add the english fallback
|
|
|
|
|
strings in
|
|
|
|
|
|
2022-04-28 18:48:00 +00:00
|
|
|
* `lng/en.lng.php`
|
|
|
|
|
* `install/lng/en.lng.php` (if applicable)
|
2017-05-01 19:24:48 +00:00
|
|
|
|
2020-10-14 12:17:37 +00:00
|
|
|
### New settings and database-layout changes
|
2022-04-28 18:48:00 +00:00
|
|
|
|
2018-12-04 09:52:49 +00:00
|
|
|
If you add new settings or layout changes, please make sure you add these to
|
2017-05-01 19:24:48 +00:00
|
|
|
|
2022-04-28 18:48:00 +00:00
|
|
|
* `install/froxlor.sql.php`
|
2018-12-04 09:52:49 +00:00
|
|
|
* and handle the update (see `install/updates/froxlor/0.10/update_0.10.inc.php`)
|
|
|
|
|
* if you have any question on how update-process works, please contact us
|
