Skip to content

Commit 0fd600c

Browse files
authored
docs: add template and issue link requirements (#8080)
1 parent 35cd691 commit 0fd600c

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
@@ -2,6 +2,7 @@
22

33
## Table of Contents <!-- omit in toc -->
44
- [Contributing](#contributing)
5+
- [Templates](#templates)
56
- [Why Contributing?](#why-contributing)
67
- [Environment Setup](#environment-setup)
78
- [Recommended Tools](#recommended-tools)
@@ -49,6 +50,22 @@ When you are ready to code, you can find more information about opening a pull r
4950

5051
Whether this is your first contribution or you are already an experienced contributor, the Parse Community has your back – don't hesitate to ask for help!
5152

53+
### Issue vs. Pull Request
54+
55+
An issue is required to be linked in every pull request. We understand that no-one likes to create an issue for something that appears to be a simple pull request, but here is why this is beneficial for everyone:
56+
57+
- An issue get more visibility than a pull request as issues can be pinned, receive bounties and it is primarily the issue list that people browse through rather than the more technical pull request list. Visibility is a key aspect so others can weigh in on issues and contribute their opinion.
58+
- The discussion in the issue is different from the discussion in the pull request. The issue discussion is focused on the issue and how to address it, whereas the discussion in the pull request is focused on a specific implemention. An issue may even have multiple pull requests because either the issue requires multiple implementations or multiple pull requests are opened to compare and test different approaches to later decide for one.
59+
- High-level conceptual discussions about the issue should be still available, even if a pull request is closed because its appraoch was discarded. If these discussions are in the pull request instead, they can easily become fragmented over multiple pull requests and issues, which can make it very hard to make sense of all aspects of an issue.
60+
61+
### Templates
62+
63+
You are required to use and completely fill out the templates for new issues and pull requests. We understand that no-one enjoys filling out forms, but here is why this is beneficial for everyone:
64+
65+
- It may take you 30 seconds longer, but will save even more time for everyone else trying to understand your issue.
66+
- It helps to fix issues and merge pull requests faster as reviewers spend less time trying to understand your issue.
67+
- It makes investigations easier when others try to understand your issue and code changes made even years later.
68+
5269
## Why Contributing?
5370

5471
Buy cheap, buy twice. What? No, this is not the Economics 101 class, but the same is true for contributing.

0 commit comments

Comments
 (0)