Docs: Updated Changelog, Contribution Guidelines and Issue Template

Author: Kristan Kenney

CHANGELOG.md

@@ -2,49 +2,56 @@
 All notable changes to this project will be documented in this file.
 
 ## [CURRENT] - Development
+
+## [1.2.0] - 2020-06-29 - Major Release (Feature / Quality Update)
 ### Features
-- Added support for configuring individual TTL per DNS record. Thanks to @jaapmarcus!
 - Added support for Ubuntu Server 20.04 LTS.
-- Added the ability to set the php cli version per user (using alias).
-- Added support for resolving ip addresses based on geoip database for Awstats
-- Added Roundcube plugins newmail_notifier and zipdownload.
+- Added File Manager functionality (Filegator).
+- Extended built-in firewall to support allowing or blocking traffic using IP lists.
+- Improved Apache2 performance by switching to mpm_event instead mod_prefork by default for new installations.
+- Added support for configuring individual TTL per DNS record. Thanks to @jaapmarcus!
+- Updated translations for Polish (thanks to @RejectPL!), Dutch, French, German, and Italian (WIP).
+- Added the ability to set the default PHP command line version per-user.
+- Added geolocation support to awstats to improve traffic reports.
+- Enabled Roundcube plugins newmail_notifier and zipdownload by default.
 - Added HELO support for multiple domains and IPs.
-- Added the possibility to manage ssh keys in the backend.
-- Switched to mpm_event instead mod_prefork for apache2 on fresh installs.
-- Added a manual migration script for apache2 mpm_event ($HESTIA/install/upgrade/manual/migrate_mpm_event.sh).
-- Added support for Linux ipset for a efficient way to handle large blocklists or country wide ip lists.
-- Extended Hestia Firewall to support allowing or blocking traffic from ipset lists.
-- Added Filemanager integration (Filegator).
+- Added the ability to manage SSH keys from CLI and web interface.
+- Added a manual migration script for apache2 mpm_event for existing installations/upgrades (`$HESTIA/install/upgrade/manual/migrate_mpm_event.sh`).
 - Added BATS system for testing the functionality of Bash scripts (WIP).
+- **NOTE:** Debian 8 is no longer supported as it has reached EOL status.
 
 ### Bugfixes
-- Do not allow to show apache2 server-status page from public.
-- Do not allow to change the password of a non-hestia user. Thanks to Alexandre Zanni!
-- Use sury repository for Apache2 packages.
+- Prevent ability to change the password of a non-Hestia user account. Thanks to Alexandre Zanni!
+- Adjust Let's Encrypt validation check for IDN domains, thanks to @zanami!
+- Set backup download location on FTP/SFTP restore, thanks to @Daniyal-Javani!
+- Stop trying to renew Let's Encrypt certificates after multiple consecutive failed attempts. Thanks to @dpeca!
+- Fixed an issue with auto-logout when used behind Cloudflare proxy and reworked 2FA authentication part. Thanks to @rmj-s!
+- Fixed an issue where changing an email account password would fail if similar account names were present.
+- Fixed an issue where e-mail quota was not preserved when (un)suspending or rebuilding a mail account.
+- Fixed an issue where SSH configuration was not saved currently when edited from the Web interface.
+- Fixed an issue where DNS IP did not use NAT/Public IP when available after changing web domain IP.
+- Fixed permission issues that were presented when restoring a user backup.
+- Use Sury.org repository for Apache2 packages.
+- Improved compatibility with Roundcube and PHP 7.4.
+- Restrict the ability to edit crontab service via Web UI.
 - Check whether Nginx, Apache2 and MariaDB are selected for installation prior to adding third party repositories.
+- Restrict public access to Apache2 server-status page.
 - Remove duplicated set-cookie line in default fpm config.
-- Adjust let's encrypt validation check for idn domains, thanks to @zanami!
-- Set backup download location on restore for ftp/sftp, thanks to @Daniyal-Javani!
 - Ignore empty lines when listing firewall rules.
-- Changing email account password would fail when similar account names are found.
-- Preserve email quota when (un)suspending and rebuilding mail account.
-- Cleanup temporary file after running v-list-sys-services.
+- Improved top-level navigation in the Control Panel web interface (Server tab has been moved next to the Notification icon).
+- Corrected various minor user interface and theme issues.
+- Cleanup temporary files when uploading custom SSL certificate from Web interface.
+- Cleanup temporary files when adding/renewing Let's Encrypt SSL certificate.
+- Cleanup temporary files after running v-list-sys-services.
 - Don't calculate /home folder size in v-list-sys-info.
-- Cleanup temporary files when uploading custom SSL cert from WebUi.
-- Cleanup temporary files when adding/renewing letsencrypt SSL cert.
 - Adjust v-list-sys-services to honor the changed fail2ban service name.
 - Rework busy port validation in v-change-sys-port.
-- Fixed ssh config save bug when edit the over interface.
-- Fixed different permission issues on user restore.
-- Stop trying to renew LE certs after multiple consecutive failed attempts. Thanks to @dpeca!
-- Implement a validation function to verify the correct version in hestia.conf prior to install a new one.
-- Fix autologout issue on cloudflare proxy and rearange 2FA authentification part. Thanks to @rmj-s!
-- Roundcube fixes for PHP 7.4 compatibility..
-- Added delay when entering wrong username/password/2fa.
-- Improved "Forgot password" function prevent brute forcing.
-- Update Backup counter propperly when v-delete-user-backup ran.
-- Dropped support for Debian 8 according to EOL.
-- Improved Backup function. 
+- Implement a validation function to verify the correct version in hestia.conf prior to installation.
+- Introduced a delay when an incorrect username, password, or 2FA code has been entered repeatedly.
+- Improved "Forgot password" function prevent brute force attacks.
+- Fixed an issue where the backup update counter was not updated properly when v-delete-user-backup was executed.
+- Fixed an issue with public_(s)html file ownership.
+- Fixed an issue with phpPgAdmin access.
 
 ## [1.1.1] - 2020-03-24 - Hotfix
 ### Features

CONTRIBUTING.md

@@ -1,24 +1,13 @@
-How to Contribute
-==================================================
-
-Do you want to contribute to the Hestia Control Panel project? The easiest way to get started is to [submit an issue report](https://github.com/hestiacp/hestia/issues) if you come across a bug or issue. If you are a developer, please feel free to submit your code via pull request for review.
-
-**We appreciate and welcome all contributions to our project; it is with the help of the open-source community that we are able to build a product that meets our users needs.**
-
 Code Contributions & Pull Requests - Guidelines
 -----------------------
 
-**All pull requests must include:**
-1. A brief but descriptive title, such as **Fixed syntax error in php.ini** or **Updated rebuild_mail_conf function in rebuild.sh**.
-2. A detailed description of the changes that you've made.
-   1. Example: "Apache subdomain configuration was incorrect, modified variables in templates to point to the correct files."
-3. Only commits which are related to the pull request or issue itself.
+All pull requests must include a brief but descriptive title, and a description of the changes that you've made with as much detail as possible. **Only include commits that are related to your feature, bug fix, or patch in your pull request.**
 
 ### Code formatting and comments:
-We ask that you please try to follow existing naming schemes and coding conventions as much as possible, and that you add brief but descriptive comments in your source code to aid other developers in debugging and understanding your code in the future.
+We ask that you follow existing naming schemes and coding conventions where possible, and that you add comments in your source code where appropriate to aid other developers in debugging and understanding your code in the future.
 
 ### Squashing commits for smaller changes:
-When submitting a pull request with multiple smaller commits which are related to the same issue (or file), we ask that you please **squash your commits** in order to keep the project's commit history clean and easy to follow for other developers. For example, if you are submitting a fix for two files which contain the same code change, merge those changes into one commit before submitting your request.
+When submitting a pull request with multiple smaller commits which are related to the same issue (or file), we ask that you please **squash your commits** in order to keep the project's commit history clean and easy to follow for other developers.
 
 ### Working with branches:
 Development for this project takes place in branches to effectively develop, manage, and test new features and code changes, helping to ensure that each release meets high quality standards. Our primary branches are as follows:

ISSUE_TEMPLATE.md

@@ -1,55 +1,25 @@
-### Please fill in the relevant sections below and remove those which do not apply.
+**Please include as much information as possible in your issue report, such as the configuration of your server and any troubleshooting steps that you've already performed.**
 
-**To help aid our developers in debugging your issue we ask that you include as much information as possible, including the configuration of your server and troubleshooting steps already performed.**
-
-**Please DO NOT include any personal or sensitive information in your issue reports, including usernames or passwords!**
+**NOTE: Do not include any personal or sensitive information, such as email addresses or passwords.**
 
 ===
 
 ### In a few words, please describe the issue that you're experiencing:
 Please enter your answer here (e.g. When I try adding a web domain, an error message appeared stating that the php-fpm pool did not exist).
 
 ### What steps did you take when the issue occured? 
-1. Ex.: Log into the Hestia Control Panel using Firefox
-2. Ex.: Click on the Web tab
-3. Ex.: Click on Add Web Domain
-4. Ex.: Attempted to add a domain and received an error.
+1. Ex.: Click on the Web tab
+2. Ex.: Click on Add Web Domain
+3. Ex.: Attempted to add a domain and received an Internal Server Error.
 
 ### Expected behavior:
 Please enter your answer here (e.g. the web domain should have been added successfully).
 
-### Does this issue always occur, or is it intermittent?
-Please enter your answer here (e.g. it happens every time I try to perform the steps above).
-
-### Operating system distribution and release:
-Please enter your answer here (e.g. Ubuntu 18.04.3 LTS)
-
-### Which version of Hestia Control Panel is currently installed?
-You can find this information in $HESTIA/conf/hestia.conf by running the following command:
-`grep VERSION $HESTIA/conf/hestia.conf`
-
-Please enter your answer here (e.g. 1.1.0)
-
-### Which branch are you using?
-Please enter your answer here (e.g release, master, etc.)
-
-### When did this issue occur? After a clean installation, or after an upgrade?
-Please enter your answer here (e.g the feature stopped working after upgrading to the latest release)
-
-**Note:** If you have upgraded from an older release on an existing server, please let us know which version was previously installed if at all possible.
-
-### Which of the following web server configurations are you using?
-- Apache + Nginx (default)
-- Nginx + PHP-FPM
-- Multi-PHP
-- PHP-FPM + Multi-PHP
-- Other (please specify)
-
-### In order to better assist, please post any relevant log information below:
-Tip: Most log files can be found under ***/var/log/***.
+### Operating system:
+Please enter your answer here (e.g. Ubuntu 20.04 LTS)
 
-### Related issues or forum threads:
-Find something that might be related to this? Please let us know by adding any relevate issue numbers or URLs here (e.g. issue #000 or https://forum.hestiacp.com/...)
+### Hestia Control Panel version:
+Please enter your answer here (e.g. 1.2.0). 
 
 ### Additional notes:
 If there is anything else that you'd like us to know about this issue, feel free to share here.