From 7d33cc17bc343f43f81756a1008d6658a9ebb714 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Anti=20R=C3=A4is?= Date: Sun, 27 Jan 2019 14:57:25 +0200 Subject: [PATCH] Create CONTRIBUTING.md (#73) --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..66920189 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Short Links to Important Resources + +* [docs](https://www.anuko.com/time_tracker/features.htm) - detailed documentation about this project can be found here +* [bugs](https://github.com/anuko/timetracker/issues) - report bugs and issues here +* [forum](https://www.anuko.com/forum/viewforum.php?f=4) - for general discussion + +# Reporting Bugs + +Create a [new issue](https://github.com/anuko/timetracker/issues). + +# Reporting Security Issues + +**#TODO** + +# Setting up a dev environment + +Use docker to run dev instance: +```bash +docker-compose up +``` + +and then navigate to: http://localhost:8080. Default credentials for initial login are: +``` +usr: admin +psw: secret +``` + +Full installation and setup guide can be found [here](https://www.anuko.com/time_tracker/install_guide/index.htm). -- 2.20.1