Move streaming docs to contributing/streaming

contributing/README.md

@@ -1,21 +1,12 @@
-# Contributing to Consul
+# Contributing to Consul
-
+
-See [our contributing guide](../.github/CONTRIBUTING.md) to get started.
+See [our contributing guide](../.github/CONTRIBUTING.md) to get started.
-
+
-This directory contains other helpful resources like checklists for making
+This directory contains documentation intended for anyone interested in
-certain common types of changes.
+understanding, and contributing changes to, the Consul codebase.
-
+
-## Checklists
+## Contents
-
+
-See the `checklist-*` files in this dir to see of there is a checklist that
+1. [Overview](./INTERNALS.md)
-applies to a change you wish to make. The most common one is a change to
+2. [Configuration](./checklist-adding-config-fields.md)
-Consul's configuration file which has a lot more steps and subtlety than might
+3. [Streaming](./streaming)
-first appear so please use the checklist!
-
-We recommend copying the raw Markdown lists into a local file or gist while you
-work and checking tasks as you complete them (by filling in `[ ]` with `[x]`).
-You can then paste the list in the PR description when you post it indicating
-the steps you've already done. If you want to post an initial draft PR before
-the list is complete, please still include the list as is so reviewers can see
-progress. You can then check the list off on the PR description directly in
-GitHub's UI after pushing the relevant fixes up.