Skip to content

Commit b1be7cc

Browse files
authored
Commit Acces to Maintainer Initial (#26920)
1 parent 0d79dc6 commit b1be7cc

File tree

3 files changed

+19
-14
lines changed

3 files changed

+19
-14
lines changed

docs/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ merged.
4242

4343
After a twenty four hour minimum waiting period, Pull Requests can be merged
4444
once they receive approval from the relevant team. An exception is made for
45-
refactors and fixes, which may be merged by any member with commit access'
46-
discretion with no waiting period.
45+
refactors and fixes, which may be merged by any maintainer with no waiting period.
4746

4847
While normally provided, voting team members are not obligated to publicly state
4948
their objections to a Pull Request. Attacking or berating a voting team member

docs/CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,9 @@ Status of your pull request will be communicated via PR labels. This includes:
123123
should never have this label
124124
- `Status: Awaiting review` - This will be displayed when your PR has passed the
125125
design vote and is now waiting for someone in the review team to approve it
126-
- `Status: Awaiting merge` - Your PR is done and is waiting for someone with
127-
commit access to merge it. **Note: Your PR may be delayed if it is pending
126+
- `Status: Awaiting merge` - Your PR is done and is waiting for a maintainer to merge it
127+
128+
**Note: Your PR may be delayed if it is pending
128129
testmerge or in the mapping queue**
129130

130131
### Mapping Standards
@@ -180,11 +181,11 @@ will automatically build them for you and update your branch.
180181
There are three roles on the GitHub:
181182

182183
- Headcoder
183-
- Commit Access
184+
- Maintainer
184185
- Review Team
185186

186-
Each role inherits the lower role's responsibilities (IE: Headcoders also have
187-
commit access, and members of commit access are also part of the review team)
187+
Each role inherits the lower role's responsibilities
188+
(IE: Headcoders are also maintainers, and maintainers are also part of the review team)
188189

189190
`Headcoders` are the overarching "administrators" of the repository. People
190191
included in this role are:
@@ -195,7 +196,7 @@ included in this role are:
195196

196197
---
197198

198-
`Commit Access` members have write access to the repository and can merge your
199+
`Maintainers` have write access to the repository and can merge your
199200
PRs. People included in this role are:
200201

201202
- [AffectedArc07](https://github.com/AffectedArc07)

docs/contributing/reviewer.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Reviewer Crash Course
22

3-
by *Sirryan*
3+
by _Sirryan_
44

55
Hey everyone, I noticed some people were not sure how to approach reviewing PRs
66
so I figured I would write up a small guide on PR reviewing and how people like
7-
our Headcoders, commit access, Lewcc, S34N, and I all do our jobs. In addition
7+
our Headcoders, maintainers, Lewcc, S34N, and I all do our jobs. In addition
88
to some guidance and pointers on PR reviewing, I will also go over a few code
99
examples and point out code standard corrections and basic errors that
1010
prospective reviewers can begin to start on.
1111

1212
## What is code review?
1313

14-
> Code reviews act as quality assurance of the code base.... *and* can also act
14+
> Code reviews act as quality assurance of the code base.... _and_ can also act
1515
> as a second step in identifying bugs, logic problems, or uncovered edge cases.
1616
> [(source)](https://about.gitlab.com/topics/version-control/what-is-code-review/)
1717
@@ -54,14 +54,15 @@ their own code and help you understand their intention and goals. Please note:
5454
ITS IMPORTANT TO READ PR DESCRIPTIONS, you should not be reviewing a PR until
5555
you know what it's actually attempting to do.
5656

57-
**But Sirryan, that's not the *kind* of code review I'm interested in learning
57+
**But Sirryan, that's not the _kind_ of code review I'm interested in learning
5858
about**. Yes, yes, I know, I'm getting there. While its important to understand
5959
the conversation (and relationship-building) parts of code review, there's also
6060
important technical parts to review that keep our codebase moving. Before
6161
getting into HOW to code review, we will take a look at the two types of
6262
technical code reviews.
6363

6464
## Comments
65+
6566
Basic comments are when a reviewer leaves a message, question, or directive for
6667
the PR author at a certain code line or chunk. For example, SteelSlayer has left
6768
a comment on Line 12 of `objective.dm` inquiring about a certain variable. The
@@ -73,6 +74,7 @@ issues to be addressed quickly and efficiently.
7374
![image](./images/reviewer_pr_conversation.png)
7475

7576
## Suggestions
77+
7678
Suggestions are when a reviewer suggests/requests a change to a certain line or
7779
chunk of code. This leaves less agency for the PR author (especially when
7880
suggested by a development team member or experienced reviewer) but allows for
@@ -85,6 +87,7 @@ most critical for enforcing code standards and making 1-5 line corrections.
8587
![image](./images/reviewer_pr_suggestions.png)
8688

8789
## Leaving PR Reviews
90+
8891
The way you leave any form of comment or suggestion directly on a line or chunk
8992
of code is under the "Files Changed" tab of the pull request. All you need to do
9093
now is scroll down to a line of code that you want to comment on and hover over
@@ -111,6 +114,7 @@ reviews, you can submit them together in the top right of the files changes tab
111114
once done.
112115

113116
## What can I start reviewing?
117+
114118
So you know what reviewing is, you know how to review, and you're ready to
115119
review.... but what do you review? Knowledge of code and willingness to
116120
understand our currently implemented systems is critically important to being
@@ -119,6 +123,7 @@ look out for on PR's to get familiarized with the code review process and get a
119123
few reviews under your belt.
120124

121125
### Problematic Code Examples
126+
122127
Lets say a contributor has opened a pull request adding a brand-new item to the
123128
game. This item has a few special functions and procs that you need to look
124129
over. I will go through each part of this code that I would leave comments or
@@ -281,8 +286,8 @@ suggest to fix them as a PR reviewer.**
281286
## The Art of Code
282287

283288
> ... I like it because I could make the computer do what I wanted and every
284-
> time I did that, I got this little thrill and this rush and throughout *my
285-
> entire career*. That thrill for me has never gone away [[The Art of Code - Dylan Beattie](https://www.youtube.com/watch?v=6avJHaC3C2U)]
289+
> time I did that, I got this little thrill and this rush and throughout _my
290+
> entire career_. That thrill for me has never gone away [[The Art of Code - Dylan Beattie](https://www.youtube.com/watch?v=6avJHaC3C2U)]
286291
287292
This segment might be a bit corny but I figured it would be important to include
288293
because I felt like it was an important aspect of reviewing that I've always had

0 commit comments

Comments
 (0)