From 159d9ea5132d8a86b6904155aeecac8df5bea17b Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 22 Oct 2016 19:22:17 +0200 Subject: [PATCH] Add contributing information --- CONTRIBUTING.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 19 +++++++----------- 2 files changed, 58 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 854139a3..26750f2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,52 @@ # Contributing + +There is quite a lot todo and planned. If you like to contribute, pick any of the below topics or contact me directly. + +Contributors will be credited within the intranet and on the github page. + + +## General + +* [ ] Handle emails sent from PHP dockers + +## Dockers + +* [ ] Add more travis checks to ensure they are always working under any condition +* [ ] Add more dockers + - [ ] MySQL 5.6 + - [ ] MySQL 5.7 + - [ ] MariaDB 5 + - [ ] MariaDB 10 + - [ ] LightHTTPD + - [ ] HHVM + - [ ] ... +* [ ] Add optional dockers + - [ ] PostgreSQL + - [ ] Memcached + - [ ] Redis + - [ ] MongoDB + - [ ] CouchDB + - [ ] Cassandra + - [ ] ... +* [ ] Add other stack dockers (instead of PHP) + - [ ] Go + - [ ] Python + - [ ] Ruby + + +## Docker-compose + +* [ ] Allow for optional dockers (via `setup.sh` script or similar) + + +## Documentation + +* [ ] Improve documentation +* [ ] Remove all typos / wrong grammar + +## Intranet + +* [ ] View emails sent/received within PHP dockers +* [ ] Better layout +* [ ] Better logos +* [ ] Try to remove as much vendor dependencies as possible diff --git a/README.md b/README.md index 51f340c1..8a9d3ba3 100644 --- a/README.md +++ b/README.md @@ -37,18 +37,6 @@ No need to install and configure different versions locally. Simply choose your | | MariaDB 10 | [PHP 7.1](https://github.com/cytopia/docker-php-fpm-7.1) | - ## Feature overview * Dynamically Configured Mass Virtual Hosting @@ -72,6 +60,13 @@ The devilbox comes with a pre-configured intranet on `http://localhost` * Opcache GUI +## Contributing + +There is quite a lot todo and planned. If you like to contribute, view [CONTRIBUTING.md](https://github.com/cytopia/devilbox/blob/master/CONTRIBUTING.md). + +Contributors will be credited within the intranet and on the github page. + + ## Screenshots **Homepage with host / docker information**