Skip to content

Commit

Permalink
Add contributing guidelines
Browse files Browse the repository at this point in the history
Regarding issues/PRs relationship.
  • Loading branch information
ffaf1 committed Feb 29, 2024
1 parent 9e5e815 commit 385fe07
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 fom 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
---------

Expand Down

0 comments on commit 385fe07

Please sign in to comment.