From 31f36e1b97ccc3f4387c80698d018a69798b6228 Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Sat, 20 Apr 2019 11:32:40 -0700 Subject: [PATCH] Added some guidelines Mainly to remind me that master needs to be releasable at all times! --- docs/contributing.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 5b7d75d2..cdea6def 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -7,6 +7,12 @@ Datasette is an open source project. We welcome contributions! This document describes how to contribute to Datasette core. You can also contribute to the wider Datasette ecosystem by creating new :ref:`plugins`. +General guidelines +------------------ + +* **master should always be releasable**. Incomplete features should live in branches. This ensures that any small bug fixes can be quickly released. +* **The ideal commit** should bundle together the implementation, unit tests and associated documentation updates. The commit message should link to an associated issue. + .. _devenvironment: Setting up a development environment