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
+15-10Lines changed: 15 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -31,10 +31,10 @@ Otherwise, create a new issue using the Constitution Issue template:
31
31
- Mark whether the issue reflects a semantic or non-semantic change to the Constitution.
32
32
- Include a short description of the issue. Include an excerpt of the language that is most in question.
33
33
34
-
Once you've created a title and description for the issue, add any relevant lablels. Several labels are available for application. Some commonly used labels for issues are:
34
+
Once you've created a title and description for the issue, add any relevant labels. Several labels are available for application. Some commonly used labels for issues are:
35
35
36
-
-`needs-discussion`: for issues that are ready for discussion at committee meetings.
37
-
-`discussion-issue`: for issues that contain longer-term discussions not ready for discussion at a committee meeting.
36
+
-`needs-discussion`: for issues that should be discussed with Maintainers.
37
+
-`discussion-issue`: for issues that require some longer-term discussions.
38
38
-`question`: for issues where further information is requested.
39
39
40
40
We'll leave the assignees section blank until the issue has been picked up and under development.
@@ -43,7 +43,7 @@ Once your issue has a title, description, and labels, it is all set! Congrats
43
43
44
44
## I Have a Question
45
45
46
-
If you have a general question about the Constitution, ask a Maintainer (@constitutionalmaintainers on slack) or during a Committee meeting.
46
+
If you have a general question about the Constitution, ask a Maintainer (@constitutionalmaintainers on slack).
47
47
48
48
If you find a section of the Constitution that requires interpretation or clarification, we recommend the following:
49
49
@@ -66,6 +66,8 @@ Lastly, assign the PR to yourself, and add any relevant labels (for example - `r
66
66
67
67
## I Want To Review A PR
68
68
69
+
> Note: only Maintainers can review PRs
70
+
69
71
Yo, that's awesome! First, add yourself as a reviewer on the PR.
70
72
71
73
Next, review the changes made in the PR. If you have questions or concerns about any of the changes, submit a review by going to `Files Changed`, highlighting the line in question, and hitting the `+`.
@@ -76,8 +78,10 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
@@ -92,7 +96,9 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
92
96
git switch <branch_name>
93
97
```
94
98
95
-
3. Install dependencies.
99
+
3. Install dependencies.
100
+
101
+
> This installs texlive on your computer. If you have another latex editor, you can skip this step and use that.
96
102
97
103
Installing dependencies on debian
98
104
@@ -116,7 +122,7 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
116
122
117
123
5. Make any changes to `constitution.tex` and save the file once ready.
118
124
119
-
6. Compile the LaTeX document.
125
+
6. Compile the LaTeX document. (when using texlive)
120
126
121
127
```
122
128
make
@@ -134,8 +140,6 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
134
140
See the [Commit Guidelines](#commit-guidelines) for more information on writing commit messages.
135
141
136
142
8. Make a Pull Request
137
-
138
-
> Double-check to ensure that your PR is made against the main branch of the `rhochgraf21/Constitution` project, not the upstream `ComputerScienceHouse/Constitution`.
139
143
140
144
Using the github cli:
141
145
@@ -147,8 +151,9 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
147
151
148
152
```
149
153
git push
150
-
# now go to github.com/rhochgraf21/Constitution > Pull Requests > New Pull Request
154
+
# now go to github.com/ComputerScienceHouse/Constitution > Pull Requests > New Pull Request
151
155
```
156
+
> Remember to set the upstream if in a Fork: git push -u origin <branch_name>
152
157
153
158
For instructions on making a Pull Request, see [I Want To Fix An Issue](#i-want-to-fix-an-issue).
0 commit comments