Skip to content

Commit a703871

Browse files
authored
Merge pull request #9759 from ffaf1/contribute
Add Issue/PR contributing guidelines
2 parents a0774dc + 6ebb8c9 commit a703871

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,23 @@ severely complicates Git history. It is intended for special circumstances, as w
265265
the PR branch cannot or should not be modified. If you have any questions about it,
266266
please ask us.
267267
268+
### Pull Requests & Issues
269+
270+
A pull request *fixes* a problem that is *described* in an issue. Make sure to
271+
file an issue before opening a pull request. In the issue you can illustrate
272+
your proposed design, UX considerations, tradeoffs etc. and work them out with
273+
other contributors. The PR itself is for implementation.
274+
275+
If a PR becomes out of sync with its issue, go back to the issue, update
276+
it, and continue the conversation there. Telltale signs of Issue/PR diverging
277+
are, for example: the PR growing bigger in scope; lengthy discussions
278+
about things that are *not* implementation choices; a change in design.
279+
280+
If your PR is trivial you can omit this process (but explain in the PR why you
281+
think it does not warrant an issue). Feel free to open a new issue (or new
282+
issues) when appropriate.
283+
284+
268285
Changelog
269286
---------
270287

0 commit comments

Comments
 (0)