Skip to content

Commit ed4fbe6

Browse files
authored
Update Community page to better reflect current processes (#177)
Fixes #176 This change makes multiple changes to the community page on the website: - Removes references to requiring reviews from 2 code owners - Makes some clarifications regarding the current state of CODEOWNERS and removes the section about how to become a code owner (given that shader-slang/dev is the owner for all directories in the Slang repo) - Fixes links to the proposals directory, which was moved from the slang repo to the spec repo, and removes mentions of its old path - Adds a note about smaller PRs being more likely to get quick reviews (within 24 hours) than larger PRs - Also removes some extra newlines that are ignored when deployed to the website but cause formatting issues when viewed on GitHub Deployed site locally with Jekyll to verify that the formatting fixes do not inadvertently break the website formatting, and to confirm that the links are valid.
1 parent bf2eca6 commit ed4fbe6

File tree

1 file changed

+17
-41
lines changed

1 file changed

+17
-41
lines changed

community/index.md

Lines changed: 17 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -72,34 +72,30 @@ intro_image_hide_on_mobile: false
7272
reviewers who are
7373
familiar with the area of code you are touching. If you have doubts, look at the git blame for the
7474
file and the
75-
CODEOWNER file.
75+
CODEOWNERS file.
7676
</p>
7777
<p>
7878
Submissions to <a
79-
href="https://github.com/shader-slang/slang/tree/master/docs/proposals">/docs/proposals/</a>
80-
considered <strong>Slang Proposed Features</strong> (SPFs), and require two <strong>Language
81-
Owners</strong> (more info
79+
href="https://github.com/shader-slang/spec/tree/master/proposals">/proposals/ in the spec repository</a>
80+
are considered <strong>Slang Proposed Features</strong> (SPFs), and require a <strong>Language
81+
Owner</strong> (more info
8282
below) to approve the submission.</p>
83-
8483
<h4>Owner</h4>
8584
<p>
86-
Every file in the Slang repository has a list of owners. An owner of a directory has the right to
87-
approve pull requests
88-
touching the directory. A pull request is approved only when at least two owners of each directory
89-
affected by the
90-
changes have given their approval. If you are a committer and think you're ready to become an owner
91-
of a directory, put
92-
up a PR to the relevant OWNERs and get two owners to review it. In case of conflict between owners,
93-
owners need to reach
94-
consensus amongst themselves.</p>
85+
An owner of a directory in the Slang repository has the right to
86+
approve pull requests touching the directory.
87+
A pull request is approved only when at least one owner of each directory
88+
affected by the changes have given their approval. Currently all members of <a
89+
href="https://github.com/orgs/shader-slang/teams/dev">shader-slang/dev</a> are owners
90+
of every directory. </p>
9591
<p>
9692
<strong>Language Owner</strong>: A language owner is the owner of the <a
97-
href="https://github.com/shader-slang/slang/tree/master/docs/proposals">/docs/proposals/</a> All
93+
href="https://github.com/shader-slang/spec/tree/master/proposals">proposals in the spec repository</a>. All
9894
new Slang language and core module
9995
features (e.g. new language syntax, new functions, or new types in the Slang core module) starts
10096
with a design document
101-
submitted to this directory. The language and core module design must be approved by two language
102-
owners before any
97+
submitted to this directory. The language and core module design must be approved by a language
98+
owner before any
10399
implementation pull request for the new language feature can be approved.
104100
</p>
105101
</div>
@@ -119,21 +115,20 @@ intro_image_hide_on_mobile: false
119115
A bug fix starts with a GitHub issue describing the bug. Any community member can submit a pull
120116
request coming from your
121117
personal fork of Slang containing fixes for the bug. Such pull requests needs to be reviewed and
122-
approved by two
123-
committers who are owners of the files being changed by the pull request. Once the pull request is
118+
approved by a
119+
committer who is familiar with the files being changed by the pull request. Once the pull request is
124120
approved and has
125121
passed all CI tests, it can be merged to the main branch. Pull requests are expected to be reviewed
126122
by the committers within 24 hours after they are created or updated, and to
127-
close within a week.</p>
123+
close within a week.
124+
Smaller pull requests will be more likely to get quick reviews than large pull requests.</p>
128125
<h4>Process for Slang Feature Changes</h4>
129126
<p>
130127
Changes that add or modify syntax, language features, Slang's core module, or the compilation and
131128
reflection API must go
132129
through our process for language changes. The full process is documented here.</p>
133-
134130
<a class="btn btn-primary" href="/community/language-change-process">Slang Feature Change
135131
Documentation</a>
136-
137132
</div>
138133
</div>
139134
</div>
@@ -172,22 +167,3 @@ intro_image_hide_on_mobile: false
172167
</div>
173168
</div>
174169
</div>
175-
176-
<div class="container">
177-
<div class="section">
178-
<div class="row">
179-
<div classs="col-12">
180-
<h3>Request to Own More Directories
181-
<hr>
182-
</h3>
183-
<p>When you are granted committer status, you will be assigned an initial set of directories that you will own based on
184-
your record of contribution. As you continue to contribute to the project, you will naturally become the owner for any
185-
new directories that you create.
186-
After landing several changes to a specific directory, you can request to be an owner of the directory by submitting a
187-
PR to modify the ./github/CODEOWNER file adding yourself to the owners list. Your PR will go through the same review
188-
process and you will become an owner once the PR is approved and merged.</p>
189-
190-
</div>
191-
</div>
192-
</div>
193-
</div>

0 commit comments

Comments
 (0)