Skip to content

Commit c3a1e79

Browse files
committed
Merge branch 'master' of github.com:squidfunk/mkdocs-material
2 parents ca7e952 + f7eb5c8 commit c3a1e79

File tree

1 file changed

+81
-27
lines changed

1 file changed

+81
-27
lines changed

docs/contributing/index.md

Lines changed: 81 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ In this section, we guide your through our processes.
114114
[report a docs issue]: reporting-a-docs-issue.md
115115
[request a change]: requesting-a-change.md
116116
[add translations]: https://github.com/squidfunk/mkdocs-material/adding-translations
117-
[create a pull request]: https://github.com/squidfunk/mkdocs-material/pulls
117+
[create a pull request]: making-a-pull-request.md
118118

119119
## Checklist
120120

@@ -168,35 +168,89 @@ with our community.
168168

169169
## Rights and responsibilities
170170

171-
As maintainers, we reserve the right and have the responsibility to close,
172-
remove, reject, or edit contributions, such as issues, discussions, comments,
173-
or commits, that do not align with our contribution guidelines and our
174-
[Code of Conduct].
171+
As maintainers, we are entrusted with the __responsibility__ to moderate
172+
communication within our community, including the authority to close, remove,
173+
reject, or edit issues, discussions, comments, commits, and to block users who
174+
__do not align__ with our contribution guidelines and our [Code of Conduct].
175+
This role requires us to be actively involved in maintaining the integrity and
176+
positive atmosphere of our community. Upholding these standards decisively
177+
ensures a respectful and inclusive environment for all members.
175178

176-
### Incomplete issues
177-
178-
We have invested significant time in reviewing our contribution process and
179-
carefully assessed the essential requirements when reviewing and responding to
180-
issues. Each field in our issue templates has been thoughtfully curated, helping
181-
us to understand your matter.
182-
183-
__Therefore, it is mandatory to fill out every field as requested__ to the best
184-
of your knowledge. We need all of this information because it ensures that every
185-
user and maintainer, regardless of their experience, can understand the content
186-
and severity of your bug report or change request.
187-
188-
__We reserve the right to close issues missing essential information__, such as
189-
but not limited to [minimal reproductions], or that do not comply with the
190-
quality standards and requirements stated in our issue templates. Issues
191-
can be reopened once the missing information has been provided.
192-
193-
[minimal reproductions]: ../guides/creating-a-reproduction.md
194179

195180
### Code of Conduct
196181

197-
As stated in our [Code of Conduct], we expect all members of our community to
198-
treat each other with respect, and use inclusive and welcoming language. We
199-
always strive to create a positive and supportive environment and do not accept
182+
Our [Code of Conduct] outlines the expectation for all community members to
183+
treat one another with respect, employing inclusive and welcoming language. Our
184+
commitment is to foster a positive and supportive environment, free of
200185
inappropriate, offensive, or harmful behavior.
201186

202-
We take violations seriously and will take appropriate action in response.
187+
We take any violations seriously and will take appropriate action in response to
188+
uphold these values.[^1]
189+
190+
[^1]:
191+
__Warning and blocking policy:__
192+
Given the increasing popularity of our project and our commitment to a
193+
healthy community, we've defined clear guidelines on how we proceed with
194+
violations:
195+
196+
1.1. __First warning:__ Users displaying repeated inappropriate, offensive,
197+
or harmful behavior will receive a first warning. This warning serves as a
198+
formal notice that their behavior is not in alignment with our community
199+
standards and Code of Conduct. The first warning is permanent.
200+
201+
1.2. __Second warning and opportunity for resolution:__ If the behavior
202+
persists, a second warning will be issued. Upon receiving the second
203+
warning, the user will be given a 5-day period for reflection, during which
204+
they are encouraged to publicly explain or apologize for their actions.
205+
This period is designed to offer an opportunity for openly clearing out any
206+
misunderstanding.
207+
208+
1.3. __Blocking:__ Should there be no response or improvement in behavior
209+
following the second warning, we reserve the right to block the user from
210+
the community and repository. Blocking is considered a last resort, used
211+
only when absolutely necessary to protect the community's integrity and
212+
positive atmosphere.
213+
214+
Blocking has been an exceptionally rare necessity in our overwhelmingly
215+
positive community, highlighting our preference for constructive dialogue
216+
and mutual respect. It aims to protect our community members and team.
217+
218+
### Incomplete issues and duplicates
219+
220+
We have invested significant time and effort in the setup of our contribution
221+
process, ensuring that we assess the essential requirements for reviewing and
222+
responding to issues effectively. Each field in our issue templates is
223+
thoughtfully designed to help us fully understand your concerns and the nature
224+
of your matter. We encourage all members to utilize the search function before
225+
submitting new issues or starting discussions to help avoid duplicates. Your
226+
cooperation is crucial in keeping our community's discussions constructive and
227+
organized.
228+
229+
- __Mandatory completion of issue templates:__ We need all of the information
230+
required in our issue templates because it ensures that every user and
231+
maintainer, regardless of their experience, can understand the content and
232+
severity of your bug report or change request.
233+
234+
- __Closing incomplete issues:__
235+
We _reserve the right to close issues lacking essential information_, such as
236+
but not limited to [minimal reproductions] or those not adhering to the
237+
quality standards and requirements specified in our issue templates. Such
238+
issues can be reopened once the missing information has been provided.
239+
240+
- __Handling duplicates:__ To maintain organized and efficient
241+
communication within our [issue tracker] and [discussion board], we
242+
_reserve the right to close any duplicated issues or lock duplicated
243+
discussions_. Opening multiple channels to ask the same question or report the
244+
same issue across different forums hinders our ability to manage and address
245+
community concerns effectively. This approach is vital for efficient time
246+
management, as duplicated questions can consume the time of multiple team
247+
members simultaneously. Ensuring that each issue or discussion is unique and
248+
progresses with new information helps us to maintain focus and support our
249+
community.
250+
251+
We further _reserve the right to immediately close discussions or issues that
252+
are reopened without providing new information_ or simply because users have
253+
not yet received a response to their issue/question, as the issue is marked as
254+
incomplete.
255+
256+
[minimal reproductions]: ../guides/creating-a-reproduction.md

0 commit comments

Comments
 (0)