diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d5d5c831..e51ae0ca 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,45 +1,31 @@ -# Contributing +# Contribution -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 -already working on it or if we don not want/need this certain change. -Of course, bugfixes are always welcome. -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. -Please focus on our API based version 0.10.x (current master). +Before you start working on a PR, contact us via [Discord](https://discord.froxlor.org) or the forum at [https://forum.froxlor.org](https://forum.froxlor.org) to get a clue whether someone else isn't already working on it or if we don not want/need this certain change. Of course, bugfixes are always welcome. + +Please always focus on the **main** branch of our [Github repository](https://github.com/Froxlor/Froxlor). ## Checklist General rules for PRs are: -* Please save us all some trouble and unnecessary round-trips by _testing_ your -changes. - +* 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... + * 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 -make sure your implementation covers all supported webservers. +### Service changes + +If you make changes to the functionality of service configurations, please make sure your implementation covers all supported services and distributions. ### l10n -If you add new language strings, please make sure you add the english fallback -strings in - -* `lng/en.lng.php` -* `install/lng/en.lng.php` (if applicable) +If you add new language strings, please make sure you add the english fallback strings in `lng/en.php`. ### New settings and database-layout changes -If you add new settings or layout changes, please make sure you add these to +If you add new settings or implement database-changes, please make sure you add these to * `install/froxlor.sql.php` -* and handle the update (see `install/updates/froxlor/0.10/update_0.10.inc.php`) +* handle the update (see [`install/updates/froxlor/update_2.x.inc.php`](https://github.com/Froxlor/Froxlor/blob/main/install/updates/froxlor/update_2.x.inc.php)) * if you have any question on how update-process works, please contact us