Skip to content

Commit 31d645a

Browse files
pikachu0542pikachu0542
authored
Rewrite Amendment (#232)
1 parent 18230e8 commit 31d645a

File tree

6 files changed

+931
-742
lines changed

6 files changed

+931
-742
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
*.synctex.gz
55
*.py
66
*.toc
7+
*.pdf

‎CONTRIBUTING.md‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
# Contributing
2+
3+
Thanks for contributing! ❤️
4+
5+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to contribute and details about the processes by which this project handles them.
6+
7+
Please make sure to read the relevant section before making your contribution. We hope these guidelines will smooth out the experience for all involved. Thank you! - Constitutional Maintainers
8+
9+
## Table of Contents
10+
11+
- [Contributing](#contributing)
12+
- [Table of Contents](#table-of-contents)
13+
- [I Found An Issue In The Constitution](#i-found-an-issue-in-the-constitution)
14+
- [I Have a Question](#i-have-a-question)
15+
- [I Want To Fix An Issue](#i-want-to-fix-an-issue)
16+
- [I Want To Review A PR](#i-want-to-review-a-pr)
17+
- [Guide - Making Changes To The Constitution](#guide---making-changes-to-the-constitution)
18+
- [Commit Guidelines](#commit-guidelines)
19+
- [Debugging](#debugging)
20+
- [Attribution](#attribution)
21+
22+
## I Found An Issue In The Constitution
23+
24+
Ooh, awesome, nice find!
25+
26+
Before reporting the issue, it is best to search through the issues list and double-check to make sure the issue does not overlap with any existing issues. If it does, it is generally recommended adding a comment on an existing issue.
27+
28+
Otherwise, create a new issue using the Constitution Issue template:
29+
30+
- In the title, include a descriptive name for the issue and, if possible, where the issue occurs in the current binding CSH Constitution (eg, the one at constitution.csh.rit.edu).
31+
- Mark whether the issue reflects a semantic or non-semantic change to the Constitution.
32+
- Include a short description of the issue. Include an excerpt of the language that is most in question.
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:
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.
38+
- `question`: for issues where further information is requested.
39+
40+
We'll leave the assignees section blank until the issue has been picked up and under development.
41+
42+
Once your issue has a title, description, and labels, it is all set! Congrats 🎉
43+
44+
## I Have a Question
45+
46+
If you have a general question about the Constitution, ask a Maintainer (@constitutionalmaintainers on slack) or during a Committee meeting.
47+
48+
If you find a section of the Constitution that requires interpretation or clarification, we recommend the following:
49+
50+
- Open an [Issue](/issues/new), as described [above](#i-found-an-issue-in-the-constitution).
51+
- Add the `question` label.
52+
53+
## I Want To Fix An Issue
54+
55+
First, find an issue on the Constitution GitHub that you'd like to work on (or, alternatively, [create one](#i-found-an-issue-in-the-constitution) 😃).
56+
57+
Next, assign the issue to yourself (and any others working on the issue) to indicate that the issue has been picked up and is under development.
58+
59+
Then, make a branch from main containing the issue number and a description of the changes in the form `issue_number-issue-description`, (eg, `3-add-anti-discrimination-policy`).
60+
61+
On the branch, modify `constitution.tex` to resolve the issue and commit your changes. Then, push to your branch and make a Pull Request on GitHub using the PR template.
62+
63+
Title your PR in the form `Resolve #Issue_Number Issue-Description` (eg, `Resolve #14 Potential Issue with Privacy in Judicials`). In the PR description, mark if this is a semantic or non-semantic change, and provide a summary of the changes made in your PR.
64+
65+
Lastly, assign the PR to yourself, and add any relevant labels (for example - `ready for review`). Your PR is now ready for review!
66+
67+
## I Want To Review A PR
68+
69+
Yo, that's awesome! First, add yourself as a reviewer on the PR.
70+
71+
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 `+`.
72+
73+
Once you've reviewed all the changes, under the `Files Changed` tab, hit the `Review Changes` button. Write a general review of the changes. If the changes are ready for finalization, hit `Approve` to let the author know the changes are ready to be merged. Otherwise, hit `Request Changes` to request changes from the author prior to merging.
74+
75+
## Guide - Making Changes To The Constitution
76+
77+
1. Create a local copy of the repository.
78+
79+
```
80+
git clone https://github.com/rhochgraf21/Constitution.git
81+
```
82+
83+
2. Check that you are not on an issue branch.
84+
85+
```
86+
git branch
87+
```
88+
89+
To switch branches, run:
90+
91+
```
92+
git switch <branch_name>
93+
```
94+
95+
3. Install dependencies.
96+
97+
Installing dependencies on debian
98+
99+
```
100+
sudo apt install texlive texlive-formats-extra make
101+
```
102+
103+
Installing depencdencies on fedora
104+
105+
```
106+
sudo yum install texlive make
107+
```
108+
109+
4. Checkout a new development branch.
110+
111+
```
112+
git checkout -b <branch_name>
113+
```
114+
115+
Follow the branch naming convention found in [I Want To Fix An Issue](#i-want-to-fix-an-issue).
116+
117+
5. Make any changes to `constitution.tex` and save the file once ready.
118+
119+
6. Compile the LaTeX document.
120+
121+
```
122+
make
123+
```
124+
125+
Visually inspect the generated PDF document to ensure your changes are correct.
126+
127+
7. Make a commit that includes your changes.
128+
129+
```
130+
git add constitution.tex
131+
git commit
132+
```
133+
134+
See the [Commit Guidelines](#commit-guidelines) for more information on writing commit messages.
135+
136+
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+
140+
Using the github cli:
141+
142+
```
143+
gh pr create
144+
```
145+
146+
Or, using standard git:
147+
148+
```
149+
git push
150+
# now go to github.com/rhochgraf21/Constitution > Pull Requests > New Pull Request
151+
```
152+
153+
For instructions on making a Pull Request, see [I Want To Fix An Issue](#i-want-to-fix-an-issue).
154+
155+
Yay! Congrats, your PR is now ready for review! ❤️
156+
157+
## Commit Guidelines
158+
159+
```
160+
Capitalized + short (80 chars or less) summary
161+
162+
More detailed explanatory text, if necessary. Wrap it to 80 characters.
163+
164+
Write your commit message in the imperative: "Fix bug" and not "Fixed
165+
bug" or "Fixes bug." This convention matches up with commit messages
166+
generated by commands like git merge and git revert.
167+
168+
Paragraphs come after blank lines.
169+
170+
- Bullet points are okay, too.
171+
- For this project, commit messages will generally be a single line.
172+
```
173+
174+
## Debugging
175+
176+
If you encounter any issues contributing to this project, please reach out to a Maintainer.
177+
178+
## Attribution
179+
This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!

‎Dockerfile‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
FROM docker.io/debian:bullseye AS builder
1+
FROM debian:12 AS builder
22

3-
RUN apt-get update -y && \
4-
apt-get install -y texlive texlive-formats-extra make git
3+
ENV TZ=America/New_York
4+
RUN apt-get update -y && apt-get install -y texlive texlive-formats-extra make git nginx
55

6-
WORKDIR /build/
6+
WORKDIR /out/
77

8-
COPY . /build/
8+
COPY . .
99

1010
RUN make
1111

12-
FROM docker.io/galenguyer/nginx:mainline
12+
FROM docker.io/nginxinc/nginx-unprivileged
13+
14+
#RUN chmod +rw -R /etc/nginx
15+
#RUN chmod +rw -R /usr/share/
1316

1417
COPY nginx.conf /etc/nginx/nginx.conf
15-
COPY --from=builder /build/constitution.pdf /usr/share/nginx/html/constitution.pdf
18+
COPY --from=builder /out/constitution.pdf /usr/share/nginx/html/constitution.pdf

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ Installing dependencies on debian
3131

3232
`sudo apt install texlive texlive-formats-extra make`
3333

34-
Installing depencdencies on fedora
34+
Installing dependencies on fedora
3535

3636
`sudo yum install texlive make`
3737

3838

3939
## Compiling the Constitution
4040
Once required software is installed, simply run `make`.
41-
Running `make` will build and link the bylaws and articles properly.
41+
Running `make` will build and link the articles properly.
4242
Review the PDF output to check for any errors before making a pull request.
4343
If additional commits are made, be sure to [rebase](https://git-scm.com/docs/git-rebase) down to one commit before submitting a pull request.
4444

0 commit comments

Comments
 (0)