From 20369c9a9ebdf39d01f3eb14cae89815acfe346f Mon Sep 17 00:00:00 2001 From: Christine Dodrill Date: Fri, 15 Dec 2017 12:15:18 -0800 Subject: [PATCH] doc/README: clarify project goals and contribution guidelines --- doc/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/README.md b/doc/README.md index a1dbfee..601477d 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,3 +6,16 @@ vastly simplified, no longer having to bring in consul or another consensus laye no more configuration generation. Project Stability: Alpha + +This project is a passion project, as such excuse the atypical setup for everything. +If you have ideas on how to improve things, please open an issue, comment on existing +issues or hit me up in a private message somewhere. I want route to be the easiest +possible way to host services of all sizes. + +Constraints I am putting on myself right now: +- Use Go as much as possible and where it makes sense use other tools +- Create solutions using experience from the "old way" of doing things to categorically eliminate problems +- Make solutions robust and fault-tolerant wherever possible as soon as possible +- Don't waste resources if you don't have to +- Always clean things up eventually +- If you have to fail, fail loudly