From 5808ea2ba12bc7da1eccca6ce8a8a240d2577e0f Mon Sep 17 00:00:00 2001 From: "J. Ryan Stinnett" Date: Wed, 18 Mar 2020 11:18:29 +0000 Subject: [PATCH] Add notes about chatting with the team --- README.md | 5 +++++ docs/review.md | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index d5bbcace..53c86dec 100644 --- a/README.md +++ b/README.md @@ -223,6 +223,11 @@ Before attempting to develop on Riot you **must** read the [developer guide for `matrix-react-sdk`](https://github.com/matrix-org/matrix-react-sdk), which also defines the design, architecture and style for Riot too. +Before starting work on a feature, it's best to ensure your plan aligns well +with our vision for Riot. Please chat with the team in +[#riot-dev:matrix.org](https://matrix.to/#/#riot-dev:matrix.org) before you +start so we can ensure it's something we'd be willing to merge. + You should also familiarise yourself with the ["Here be Dragons" guide ](https://docs.google.com/document/d/12jYzvkidrp1h7liEuLIe6BMdU0NUjndUYI971O06ooM) to the tame & not-so-tame dragons (gotchas) which exist in the codebase. diff --git a/docs/review.md b/docs/review.md index ff612e03..576cb2a0 100644 --- a/docs/review.md +++ b/docs/review.md @@ -74,3 +74,8 @@ files in a PR, authors should be prepared for Design and / or Product teams to request a link to an ad-hoc build of Riot (hosted anywhere) that can be used for the review. In the future, we [hope to automate this](https://github.com/vector-im/riot-web/issues/12624) for every PR. + +Before starting work on a feature, it's best to ensure your plan aligns well +with our vision for Riot. Please chat with the team in +[#riot-dev:matrix.org](https://matrix.to/#/#riot-dev:matrix.org) before you +start so we can ensure it's something we'd be willing to merge.