Skip to content

Commit 1b8f53f

Browse files
Fixed a typos and linebreaks that were mucking up markdown rendering
1 parent 99b8b32 commit 1b8f53f

File tree

1 file changed

+22
-38
lines changed

1 file changed

+22
-38
lines changed

_pages/rfc-pairing.md

Lines changed: 22 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
layout: pageminimal
3-
title: "RFC [r] - WeAllJS #pairing"
3+
title: "WeAllJS #pairing"
44
permalink: /rfc-pairing
55
---
66

7-
# RFC [r] - WeAllJS #pairing
7+
# We All JS #pairing
88

99
[ratified 2016-09-17]
1010
{: text-italic}
@@ -15,40 +15,27 @@ Here at We All JS, we recommend two different forms of cooperative programming.
1515

1616
## Code Review
1717

18-
Code review is an extremely useful medium for cooperative learning. A more experienced person reviewing code from a newcomer
19-
might find that new techniques and technologies have emerged that are out of their expertise. Newcomers can benefit
20-
from the knowledge of individuals who have put their experience to the test.
18+
Code review is an extremely useful medium for cooperative learning. A more experienced person reviewing code from a newcomer might find that new techniques and technologies have emerged that are out of their expertise. Newcomers can benefit from the knowledge of individuals who have put their experience to the test.
2119

22-
You are free to ask for code review in any way you like, but here is our suggestion
23-
* Push your code to a Github repository.
24-
* Open a feature branch, and start coding away.
25-
* Push the feature branch upstream, and open a pull request from that feature branch into master. To do this, go to your
26-
project's homepage, and there should be a button that says **New pull request**. Click this button. Select master as your base
27-
branch, and your feature branch as the compare branch. Then, click the **Create pull request** button.
28-
* This should bring you to a page where you can write a description. Describe your problem, and what your pull request is aiming to
29-
solve. Indicate to reviewers the files and sections of code that you would like review on. After you are done, click **Create pull
30-
request.**
31-
* You should now be at a pull request page. Copy the link and paste it into the channel, asking for review. Indicate the languages and
32-
frameworks you are using.
33-
* Reviewers should go into the page, and select the Files changed tab. In this tab, one can see the diffs of the commits.
34-
Hovering your mouse over the diff should display a plus sign. Clicking on this plus sign will allow the reviewer to make line notes
35-
* As reviews come in, respond to code review by making appropriate code changes. You are also able to reply to inline comment by
36-
commenting on the same line. Talk it out, and don't be afraid to ask questions either on the pull request page, or on
37-
the `#pairing` channel. Push up any commits you make in the process.
38-
* Once reviewers feel good about the code, they can send a :+1: or a +1 to indicate the commit looks ready to be merged
39-
into master. They can do this by going to the main pull request page, scrolling to the bottom, entering text into the
40-
comment box, and pressing **Comment**.
41-
* Once you feel good about your pull request, you can feel free to merge it into master, either through the **Merge pull request**
42-
button on the pull request page, or through some other git interface of your choice; like, merging into master and pushing
43-
the changes back up on the command line.
20+
You are free to ask for code review in any way you like, but here is our suggestion:
21+
22+
* Push your code to a Github repository.
23+
* Open a feature branch, and start coding away.
24+
* Push the feature branch upstream, and open a pull request from that feature branch into master. To do this, go to your project's homepage, and there should be a button that says **New pull request**. Click this button. Select master as your base branch, and your feature branch as the compare branch. Then, click the **Create pull request** button.
25+
* This should bring you to a page where you can write a description. Describe your problem, and what your pull request is aiming to solve. Indicate to reviewers the files and sections of code that you would like review on. After you are done, click **Create pull request.**
26+
* You should now be at a pull request page. Copy the link and paste it into the channel, asking for review. Indicate the languages and frameworks you are using.
27+
* Reviewers should go into the page, and select the Files changed tab. In this tab, one can see the diffs of the commits. Hovering your mouse over the diff should display a plus sign. Clicking on this plus sign will allow the reviewer to make line notes
28+
* As reviews come in, respond to code review by making appropriate code changes. You are also able to reply to inline comment by commenting on the same line. Talk it out, and don't be afraid to ask questions either on the pull request page, or on the `#pairing` channel. Push up any commits you make in the process.
29+
* Once reviewers feel good about the code, they can send a :+1: or a +1 to indicate the commit looks ready to be merged into master. They can do this by going to the main pull request page, scrolling to the bottom, entering text into the comment box, and pressing **Comment**.
30+
* Once you feel good about your pull request, you can feel free to merge it into master, either through the **Merge pull request** button on the pull request page, or through some other git interface of your choice; like, merging into master and pushing the changes back up on the command line.
4431

4532
In this process, we ask that you respect all We All JS rules during code review. Additionally, remember to be constructive
46-
with your review, and to not be combatative when receiving review. We want to foster a place where less experienced coders
33+
with your review, and to not be combative when receiving review. We want to foster a place where less experienced coders
4734
can feel free to review and comment on the work of their more experienced peers.
4835

4936
When considering whether or not you should code review something, the only thing we ask is that you try your best to be
5037
constructive. You do not need to review an entire PR, but we ask that, until code review is complete, you try as best as
51-
posssible to follow through on responding to any review you may have posted.
38+
possible to follow through on responding to any review you may have posted.
5239

5340
When considering posting a set of commits up for review, we ask that you try and remain focused in your commits. It is
5441
hard to review a massive set of changes, and review is most effective when reviewers are able to comprehensively review
@@ -59,16 +46,13 @@ review is complete.
5946
Live pairing involves two or more people on a call, looking at the same code. Feel free to make requests for live pairing
6047
in the channel. You can be someone looking to pair on someone else's work, or someone looking to pair on your own work.
6148
We ask that, when searching for live pairing, that you please be open to working with people of all skill levels.
62-
Additionally, we require that you respect all We All JS rules while pairing with other members of the Slack.
49+
Additionally, we require that you respect all We All JS rules while pairing with other members of the Slack.
50+
51+
Here are a few suggestions for improving your experience:
6352

64-
Here are a few suggestions for improving your experience
65-
* Move slowly, if either member who is pairing does not understand something, it is beneficial to both people pairing
66-
to slow down, and explore it together. Pairing is excellent for deepening the knowledge of everyone involve.
67-
* Try diving deep in a topic. Pairing is great for getting work done, but it is even better for challenging any
68-
expectations one might have about the work that they do. If someone has a deep question you can't answer, you can
69-
both learn together.
70-
* Google Hangouts is a good enough tool to get pairing done, but Screenhero is an even better option that allows
71-
for people to remotely edit code on the same screen.
53+
* Move slowly, if either member who is pairing does not understand something, it is beneficial to both people pairing to slow down, and explore it together. Pairing is excellent for deepening the knowledge of everyone involve.
54+
* Try diving deep in a topic. Pairing is great for getting work done, but it is even better for challenging any expectations one might have about the work that they do. If someone has a deep question you can't answer, you can both learn together.
55+
* Google Hangouts is a good enough tool to get pairing done, but Screenhero is an even better option that allows for people to remotely edit code on the same screen.
7256

7357
## How to Find a Partner
7458
The slack will maintain a spreadsheet of individuals looking for live pairing or code review. Once you ask for review,

0 commit comments

Comments
 (0)