doc: extend notes about contributing; add issue template
This commit is contained in:
58
.github/CONTRIBUTING.md
vendored
Normal file
58
.github/CONTRIBUTING.md
vendored
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
# 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
|
||||||
|
already working on it or if we don't want to invest the effort in favour of
|
||||||
|
working on Froxlor 2.0.
|
||||||
|
Of course, bug fixes 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.
|
||||||
|
Currently, we are working on a complete re-write, which, at this point in
|
||||||
|
time, is not yet public to keep delays due to discussions about internal
|
||||||
|
details to a minimum.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
General rules for PRs are:
|
||||||
|
* 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
|
||||||
|
make sure your implementation covers both apache **and** nginx.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### l10n
|
||||||
|
|
||||||
|
If you add new language strings, please make sure you add the english fallback
|
||||||
|
strings in
|
||||||
|
|
||||||
|
* `lng/english.lng.php`
|
||||||
|
* `install/lng/english.lng.php` (if applicable)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### New settings
|
||||||
|
If you add new settings, please make sure you add the default values to
|
||||||
|
|
||||||
|
* `install/froxlor.sql`
|
||||||
|
* handle the update (see `install/updates/froxlor/0.9/update_0.9.inc.php`)
|
||||||
64
.github/ISSUE_TEMPLATE.md
vendored
Normal file
64
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
# Bug report vs. support request
|
||||||
|
If you're unsure of whether your problem is a bug or a configuration error
|
||||||
|
* contact us via IRC in #froxlor on freenode
|
||||||
|
* or post a thread in our forum at https://forum.froxlor.org
|
||||||
|
|
||||||
|
As a rule of thumb: before reporting an issue
|
||||||
|
* see if it hasn't been [reported](https://github.com/Froxlor/froxlor/issues) (and possibly already been [fixed](https://github.com/Froxlor/froxlor/issues?utf8=✓&q=is:issue%20is:closed)) first
|
||||||
|
* try with the git master
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Summary
|
||||||
|
|
||||||
|
Please provide a concise summary of the problem you're experiencing...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# System information
|
||||||
|
* Froxlor version: $version/$gitSHA1
|
||||||
|
* Web server: apache2/nginx/lighttpd
|
||||||
|
* DNS server: Bind/PowerDNS (standalone)/PowerDNS (Bind-backend)
|
||||||
|
* POP/IMAP server: Courier/Dovecot
|
||||||
|
* SMTP server: postfix/exim
|
||||||
|
* FTP server: proftpd/pureftpd
|
||||||
|
* OS/Version: ...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Steps to reproduce
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Expected behavior
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Actual behavior
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Log files/log entries
|
||||||
|
syslog:
|
||||||
|
<pre>
|
||||||
|
example
|
||||||
|
</pre>
|
||||||
11
README.md
11
README.md
@@ -74,13 +74,4 @@ It may be possible to fix these issues, but they are not a priority at the momen
|
|||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Before you start working on a PR, contact us via IRC or the forum to get a
|
[see here](.github/CONTRIBUTING.md)
|
||||||
clue whether someone else isn't already working on it or if we don't want to
|
|
||||||
invest the effort in favour of working on Froxlor 2.0.
|
|
||||||
Of course, bug fixes 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.
|
|
||||||
Currently, we are working on a complete re-write, which, at this point in
|
|
||||||
time, is not yet public to keep delays due to discussions about internal
|
|
||||||
details to a minimum.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user