From e20a36ada2e62b7621703e8e152fb6afda35d64e Mon Sep 17 00:00:00 2001 From: Jelle Zijlstra Date: Mon, 21 Aug 2017 13:26:00 -0700 Subject: [PATCH] add to CONTRIBUTING (#1560) Ask contributors to better explain their changes and link to documentation and code. These things generally make pull requests easier to review. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5bf687557..1337d588e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,6 +69,12 @@ For every pull request, we aim to promptly either merge it or say why it's not yet ready; if you go a few days without a reply, please feel free to ping the thread by adding a new comment. +To get your pull request merged sooner, you should explain why you are +making the change. For example, you can point to a code sample that is +processed incorrectly by a type checker. It is also helpful to add +links to online documentation or to the implementation of the code +you are changing. + At present the core developers are (alphabetically): * David Fisher (@ddfisher) * Łukasz Langa (@ambv)