You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+8-101
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Bug reports should have a structure similar to (borrowed from rust-lang):
23
23
Instead, this happened: <explanation>
24
24
25
25
Backtrace: (copy from terminal)
26
-
26
+
27
27
## Pull Requests
28
28
29
29
Pull requests are the primary mechanism we use to improve Tessel. GitHub itself
@@ -42,7 +42,13 @@ If you haven't already, [fork the repository](https://help.github.com/articles/f
42
42
Fix the bug or add the feature. Please make descriptive and focused git commits. Be sure to add relevant tests. If you have any questions, feel free to comment on the original Github issue and we'll get back to you as quickly as possible.
43
43
44
44
### 4. Make a Pull Request
45
-
Once you've implemented and tested the change, open a [pull request][pull-requests] on your branch. If there is someone in the community that you would specifically like to have review your code, call them out on the pull request with a comment like `review? @johnnyman727` and that person will assist shortly. Otherwise, one of the project [Team Members](https://github.com/tessel/project/blob/master/GOVERNANCE.md#team-members) will review the code and provide feedback.
45
+
Once you've implemented and tested the change, open a [pull request][pull-requests] on your branch.
46
+
47
+
If there is someone in the community that you would specifically like to have review your code, call them out on the pull request with a comment like `review? @johnnyman727` and that person will assist shortly.
48
+
49
+
Otherwise, one of the project [Team Members](https://github.com/tessel/project/blob/master/TEAM-MEMBERS.md) will review the code and provide feedback.
50
+
51
+
You may also wish to post to the #reviews channel on [Tessel Slack](https://tessel-slack.herokuapp.com/).
46
52
47
53
### 5. Merge the PR
48
54
After the code has been reviewed, the Team Member may suggest several things to change about the contribution before it's ready. After the necessary changes have been made, the Team Member will accept the pull request and merge it into the master branch!
@@ -69,105 +75,6 @@ Additionally:
69
75
- Double check PR's to make sure the person's _full name_ and email address are correct before merging.
70
76
- Except when updating dependencies, all commits should be self-contained. Meaning, every commit should pass all tests. This makes it much easier when bisecting to find a breaking change.
71
77
72
-
### Technical HOWTO for PRs
73
-
74
-
_Optional:_ ensure that you are not in a borked `am`/`rebase` state
75
-
76
-
```text
77
-
$ git am --abort
78
-
$ git rebase --abort
79
-
```
80
-
81
-
Checkout proper target branch
82
-
83
-
```text
84
-
$ git checkout v1.x
85
-
```
86
-
87
-
Update the tree
88
-
89
-
```text
90
-
$ git fetch origin
91
-
$ git merge --ff-only origin/v1.x
92
-
```
93
-
94
-
Apply external patches
95
-
96
-
```text
97
-
$ curl https://github.com/iojs/io.js/pull/xxx.patch | git am --whitespace=fix
98
-
```
99
-
100
-
Check and re-review the changes
101
-
102
-
```text
103
-
$ git diff origin/master
104
-
```
105
-
106
-
Check number of commits and commit messages
107
-
108
-
```text
109
-
$ git log origin/master
110
-
```
111
-
112
-
If there are multiple commits that relate to the same feature or one with a feature and separate with a test for that feature - you'll need to squash them (or strictly speaking `fixup`).
113
-
114
-
```text
115
-
$ git rebase -i origin/master
116
-
```
117
-
118
-
This will open a screen like this (in the default shell editor):
119
-
120
-
```text
121
-
pick 6928fc1 crypto: add feature A
122
-
pick 8120c4c add test for feature A
123
-
pick 51759dc feature B
124
-
pick 7d6f433 test for feature B
125
-
126
-
# Rebase f9456a2..7d6f433 onto f9456a2
127
-
#
128
-
# Commands:
129
-
# p, pick = use commit
130
-
# r, reword = use commit, but edit the commit message
131
-
# e, edit = use commit, but stop for amending
132
-
# s, squash = use commit, but meld into previous commit
133
-
# f, fixup = like "squash", but discard this commit's log message
134
-
# x, exec = run command (the rest of the line) using shell
135
-
#
136
-
# These lines can be re-ordered; they are executed from top to bottom.
137
-
#
138
-
# If you remove a line here THAT COMMIT WILL BE LOST.
139
-
#
140
-
# However, if you remove everything, the rebase will be aborted.
141
-
#
142
-
# Note that empty commits are commented out
143
-
```
144
-
145
-
Replace a couple of `pick`s with `fixup` to squash them into a previous commit:
146
-
147
-
```text
148
-
pick 6928fc1 crypto: add feature A
149
-
fixup 8120c4c add test for feature A
150
-
pick 51759dc feature B
151
-
fixup 7d6f433 test for feature B
152
-
```
153
-
154
-
Replace `pick` with `reword` to change the commit message:
155
-
156
-
```text
157
-
reword 6928fc1 crypto: add feature A
158
-
fixup 8120c4c add test for feature A
159
-
reword 51759dc feature B
160
-
fixup 7d6f433 test for feature B
161
-
```
162
-
163
-
Save the file and close the editor, you'll be asked to enter new commit message for that commit, and everything else should go smoothly. Note that this is a good moment to fix incorrect commit logs, ensure that they are properly formatted, and add `Reviewed-By` line.
164
-
165
-
Time to push it:
166
-
167
-
```text
168
-
$ git push origin master
169
-
```
170
-
171
78
---
172
79
173
80
Attribution: Parts of this guide are based on the io.js [COLLABORATOR_GUIDE](https://github.com/nodejs/io.js/blob/master/COLLABORATOR_GUIDE.md).
0 commit comments