Skip to content

Commit 279d4c2

Browse files
authored
Merge pull request #251 from Titanium-Lung/update-contributing-guide
2 parents 3cbec95 + 7538e69 commit 279d4c2

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ Otherwise, create a new issue using the Constitution Issue template:
3131
- Mark whether the issue reflects a semantic or non-semantic change to the Constitution.
3232
- Include a short description of the issue. Include an excerpt of the language that is most in question.
3333

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:
3535

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.
3838
- `question`: for issues where further information is requested.
3939

4040
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
4343

4444
## I Have a Question
4545

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).
4747

4848
If you find a section of the Constitution that requires interpretation or clarification, we recommend the following:
4949

@@ -66,6 +66,8 @@ Lastly, assign the PR to yourself, and add any relevant labels (for example - `r
6666

6767
## I Want To Review A PR
6868

69+
> Note: only Maintainers can review PRs
70+
6971
Yo, that's awesome! First, add yourself as a reviewer on the PR.
7072

7173
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
7678

7779
1. Create a local copy of the repository.
7880

81+
> If you are not a Maintainer, make a Fork first
82+
7983
```
80-
git clone https://github.com/rhochgraf21/Constitution.git
84+
git clone https://github.com/ComputerScienceHouse/Constitution.git
8185
```
8286
8387
2. Check that you are not on an issue branch.
@@ -92,7 +96,9 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
9296
git switch <branch_name>
9397
```
9498
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.
96102
97103
Installing dependencies on debian
98104
@@ -116,7 +122,7 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
116122
117123
5. Make any changes to `constitution.tex` and save the file once ready.
118124
119-
6. Compile the LaTeX document.
125+
6. Compile the LaTeX document. (when using texlive)
120126
121127
```
122128
make
@@ -134,8 +140,6 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
134140
See the [Commit Guidelines](#commit-guidelines) for more information on writing commit messages.
135141
136142
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`.
139143
140144
Using the github cli:
141145
@@ -147,8 +151,9 @@ Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Re
147151
148152
```
149153
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
151155
```
156+
> Remember to set the upstream if in a Fork: git push -u origin <branch_name>
152157
153158
For instructions on making a Pull Request, see [I Want To Fix An Issue](#i-want-to-fix-an-issue).
154159

0 commit comments

Comments
 (0)