From fd712d134a64663582fe7d3c0503f9816a54eb6e Mon Sep 17 00:00:00 2001 From: ADTC Date: Thu, 25 Feb 2021 22:31:18 +0800 Subject: [PATCH] Give info in the Contributing page about doc updates (#1405) Please see #1399 for more info and discussion. --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6034c3..62e3558 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,7 @@ * Bugfixes * Performance improvements * Features that are likely to be useful to the majority of Liquid users +* Documentation updates that are concise and likely to be useful to the majority of Liquid users ## Things we won't merge @@ -14,11 +15,13 @@ * Features that can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem) * Code that does not include tests * Code that breaks existing tests +* Documentation changes that are verbose, incorrect or not important to most people (we want to keep it simple and easy to understand) ## Workflow * Fork the Liquid repository * Create a new branch in your fork + * For updating [Liquid documentation](https://shopify.github.io/liquid/), create it from `gh-pages` branch. (You can skip tests.) * If it makes sense, add tests for your code and/or run a performance benchmark * Make sure all tests pass (`bundle exec rake`) * Create a pull request