From 4b5e5f36a57a94c764886d21443882b6b8608566 Mon Sep 17 00:00:00 2001 From: oclyke Date: Sat, 29 Aug 2020 02:20:09 -0600 Subject: [PATCH] add development lifecycle blurb --- docs/CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index caee34a3..4f8066d6 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,3 +1,14 @@ +Development Lifecycle +===================== +A typical contribution to this repo follows this path: +* fork the repo +* make a new branch for your work (based on any branch that suits your needs) +* make a pull request into the ```dev``` branch + * when merged this will trigger CI jobs +* merged PRs in the dev branch will be mirrored in the ```release-candidate``` branch automatically +* maintainers will merge ```release-candidate``` into ```master``` when a new release is created + * this maintains the ```master``` branch even with the latest release, and the ```dev``` branch as the cutting-edge + What to Contribute ================== Goals of this Arduino core, listed in order of priority, are: