From 32cf48122ff912f2620e3c38dbb0f55566fc797d Mon Sep 17 00:00:00 2001 From: Chris McCormick Date: Tue, 26 Nov 2019 15:32:08 +0800 Subject: [PATCH] First pass at contributor docs. --- README.md | 17 +++++++++++++++-- docs/CONTRIBUTING.md | 9 +++++++++ 2 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index 343898a..f233acb 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,23 @@ The tiniest Heroku/CloudFoundry-like PaaS you've ever seen. ## Goals and Motivation -(New text being summarized and drafted in #134, soon to find its way here) - I kept finding myself wanting an Heroku/CloudFoundry-like way to deploy stuff on a few remote ARM boards and [my Raspberry Pi cluster][raspi-cluster], but since [dokku][dokku] didn't work on ARM at the time and even `docker` can be overkill sometimes, I decided to roll my own. +### Core values + + * Runs on low end devices. + * Accessible to hobbyists and K-12 schools. + * ~1000 lines readable code. + * Functional code style. + * Few (single?) dependencies. + * [12 factor app](https://12factor.net). + * Simplify user experience. + * Cover 80% of common use cases. + * Sensible defaults. + * Leverage distro packages. + * Leverage standard tooling (git, ssh, uwsgi). + * Preserve backwards compatibility where possible. + ## Using `piku` `piku` supports a Heroku-like workflow, like so: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..685f2dc --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,9 @@ +We welcome contributions! + +### Guidelines + + * Small and focused PRs. Please don't include changes that don't address the subject of your PR. + * Follow the style of importing functions directly e.g. `from os.path import abspath`. + * Check out the [core values of Piku](../README.md#guidelines). + * PEP8. +