From 94e15268d58d89f6a6d08df7a85a8015c8c7a10e Mon Sep 17 00:00:00 2001 From: Francesco Ariis Date: Thu, 29 Feb 2024 20:41:52 +0100 Subject: [PATCH] Add contributing guidelines Regarding issues/PRs relationship. --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d639430354e..3050e6c3845 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -265,6 +265,22 @@ severely complicates Git history. It is intended for special circumstances, as w the PR branch cannot or should not be modified. If you have any questions about it, please ask us. +### Pull Requests & Issues + +A pull request *fixes* a problem that is *described* in an issue. Make sure +to file an issue before opening a pull request, bar from trivial PRs. In the +issue you can illustrate your proposed design, UX considerations, tradeoffs +etc. and work them out with other contributors. The PR itself is for +implementation. + +If a PR becomes out of sync with its issue, go back to the issue, update +it, and continue the conversation there. Telltale signs of Issue/PR diverging +are, for example: the PR growing bigger in scope; lengthy discussions +about things that are *not* implementation choices; a change in design. + +Feel free to open a new issue (or new issues) when appropriate. + + Changelog ---------