Skip to content

Commit dcb2a0a

Browse files
committed
Update pull-requests.md
1 parent 9909683 commit dcb2a0a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

how-to-work-with-us/pull-requests.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Anatomy of a Pull Request and Submission Protocol
22

3-
A pull request (PR) is a request to merge changes you have made to an existing branch of a project. For specific guidelines on which branch to submit pull requests to, see the contributing guidelines in that specific project repo.
3+
A pull request (PR) is a request to merge changes you have made to an existing branch of a project. For specific guidelines on which branch to submit pull requests to, see the contributing guidelines in that specific project repo (usually in a contributing.md file at the root of the project).
44

55
Here are some guidelines for what information to include in your PR, when to submit a PR and when to wait to submit one.
66

@@ -18,6 +18,7 @@ To explain your PR, include:
1818
- Any new issues or conflicts that your changes might create.
1919
- Screenshots or useful links to explain your PR wherever relevant
2020

21+
Before submitting a PR please also make sure you have removed any debugging code (var_logs, etc.), commented out code and unnecessary code comments (such as pseudocode or your personal notes).
2122

2223
### FAQs
2324

@@ -31,7 +32,7 @@ Wait to submit a PR if you still have more edits to do or more content to add. M
3132

3233
##### What should I expect after submitting a PR?
3334

34-
After your submit a PR, designated team members (usually a primary and secondary reviewer for each of our projects) will get a chance to review your work. Your PR may undergo changes before it is merged, so don't be surprised, discouraged, or hurt if we ask you to change things or if we make changes ourselves.
35+
After your submit a PR, designated team members (usually a primary and secondary reviewer for each of our projects as designated in the project's contributing.md) will get a chance to review your work. Your PR may undergo changes before it is merged, so don't be surprised, discouraged, or hurt if we ask you to change things or if we make changes ourselves.
3536

3637
##### What does a good PR look like?
3738

0 commit comments

Comments
 (0)