mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-12-18 18:36:07 +01:00
Updated Contributing Guide (#6819)
This commit is contained in:
parent
10a97aa72f
commit
9a79e1ecf4
@ -114,7 +114,7 @@ In this section, we guide your through our processes.
|
|||||||
[report a docs issue]: reporting-a-docs-issue.md
|
[report a docs issue]: reporting-a-docs-issue.md
|
||||||
[request a change]: requesting-a-change.md
|
[request a change]: requesting-a-change.md
|
||||||
[add translations]: https://github.com/squidfunk/mkdocs-material/adding-translations
|
[add translations]: https://github.com/squidfunk/mkdocs-material/adding-translations
|
||||||
[create a pull request]: https://github.com/squidfunk/mkdocs-material/pulls
|
[create a pull request]: making-a-pull-request.md
|
||||||
|
|
||||||
## Checklist
|
## Checklist
|
||||||
|
|
||||||
@ -168,35 +168,89 @@ with our community.
|
|||||||
|
|
||||||
## Rights and responsibilities
|
## Rights and responsibilities
|
||||||
|
|
||||||
As maintainers, we reserve the right and have the responsibility to close,
|
As maintainers, we are entrusted with the __responsibility__ to moderate
|
||||||
remove, reject, or edit contributions, such as issues, discussions, comments,
|
communication within our community, including the authority to close, remove,
|
||||||
or commits, that do not align with our contribution guidelines and our
|
reject, or edit issues, discussions, comments, commits, and to block users who
|
||||||
[Code of Conduct].
|
__do not align__ with our contribution guidelines and our [Code of Conduct].
|
||||||
|
This role requires us to be actively involved in maintaining the integrity and
|
||||||
|
positive atmosphere of our community. Upholding these standards decisively
|
||||||
|
ensures a respectful and inclusive environment for all members.
|
||||||
|
|
||||||
### Incomplete issues
|
|
||||||
|
|
||||||
We have invested significant time in reviewing our contribution process and
|
|
||||||
carefully assessed the essential requirements when reviewing and responding to
|
|
||||||
issues. Each field in our issue templates has been thoughtfully curated, helping
|
|
||||||
us to understand your matter.
|
|
||||||
|
|
||||||
__Therefore, it is mandatory to fill out every field as requested__ to the best
|
|
||||||
of your knowledge. We need all of this information because it ensures that every
|
|
||||||
user and maintainer, regardless of their experience, can understand the content
|
|
||||||
and severity of your bug report or change request.
|
|
||||||
|
|
||||||
__We reserve the right to close issues missing essential information__, such as
|
|
||||||
but not limited to [minimal reproductions], or that do not comply with the
|
|
||||||
quality standards and requirements stated in our issue templates. Issues
|
|
||||||
can be reopened once the missing information has been provided.
|
|
||||||
|
|
||||||
[minimal reproductions]: ../guides/creating-a-reproduction.md
|
|
||||||
|
|
||||||
### Code of Conduct
|
### Code of Conduct
|
||||||
|
|
||||||
As stated in our [Code of Conduct], we expect all members of our community to
|
Our [Code of Conduct] outlines the expectation for all community members to
|
||||||
treat each other with respect, and use inclusive and welcoming language. We
|
treat one another with respect, employing inclusive and welcoming language. Our
|
||||||
always strive to create a positive and supportive environment and do not accept
|
commitment is to foster a positive and supportive environment, free of
|
||||||
inappropriate, offensive, or harmful behavior.
|
inappropriate, offensive, or harmful behavior.
|
||||||
|
|
||||||
We take violations seriously and will take appropriate action in response.
|
We take any violations seriously and will take appropriate action in response to
|
||||||
|
uphold these values.[^1]
|
||||||
|
|
||||||
|
[^1]:
|
||||||
|
__Warning and blocking policy:__
|
||||||
|
Given the increasing popularity of our project and our commitment to a
|
||||||
|
healthy community, we've defined clear guidelines on how we proceed with
|
||||||
|
violations:
|
||||||
|
|
||||||
|
1.1. __First warning:__ Users displaying repeated inappropriate, offensive,
|
||||||
|
or harmful behavior will receive a first warning. This warning serves as a
|
||||||
|
formal notice that their behavior is not in alignment with our community
|
||||||
|
standards and Code of Conduct. The first warning is permanent.
|
||||||
|
|
||||||
|
1.2. __Second warning and opportunity for resolution:__ If the behavior
|
||||||
|
persists, a second warning will be issued. Upon receiving the second
|
||||||
|
warning, the user will be given a 5-day period for reflection, during which
|
||||||
|
they are encouraged to __publicly explain or apologize for their actions__.
|
||||||
|
This period is designed to offer an opportunity for openly clearing out any
|
||||||
|
misunderstanding.
|
||||||
|
|
||||||
|
1.3. __Blocking:__ Should there be no response or improvement in behavior
|
||||||
|
following the second warning, we reserve the right to block the user from
|
||||||
|
the community and repository. Blocking is considered a last resort, used
|
||||||
|
only when absolutely necessary to protect the community's integrity and
|
||||||
|
positive atmosphere.
|
||||||
|
|
||||||
|
Blocking has been an exceptionally rare necessity in our overwhelmingly
|
||||||
|
positive community, highlighting our preference for constructive dialogue
|
||||||
|
and mutual respect. It aims to protect our community members and team.
|
||||||
|
|
||||||
|
### Incomplete issues and duplicates
|
||||||
|
|
||||||
|
We have invested significant time and effort in the setup of our contribution
|
||||||
|
process, ensuring that we assess the essential requirements for reviewing and
|
||||||
|
responding to issues effectively. Each field in our issue templates is
|
||||||
|
thoughtfully designed to help us fully understand your concerns and the nature
|
||||||
|
of your matter. We encourage all members to utilize the search function before
|
||||||
|
submitting new issues or starting discussions to help avoid duplicates. Your
|
||||||
|
cooperation is crucial in keeping our community's discussions constructive and
|
||||||
|
organized.
|
||||||
|
|
||||||
|
- __Mandatory completion of issue templates:__ We need all of the information
|
||||||
|
required in our issue templates because it ensures that every user and
|
||||||
|
maintainer, regardless of their experience, can understand the content and
|
||||||
|
severity of your bug report or change request.
|
||||||
|
|
||||||
|
- __Closing incomplete issues:__
|
||||||
|
We _reserve the right to close issues lacking essential information_, such as
|
||||||
|
but not limited to [minimal reproductions] or those not adhering to the
|
||||||
|
quality standards and requirements specified in our issue templates. Such
|
||||||
|
issues can be reopened once the missing information has been provided.
|
||||||
|
|
||||||
|
- __Handling duplicates:__ To maintain organized and efficient
|
||||||
|
communication within our [issue tracker] and [discussion board], we
|
||||||
|
_reserve the right to close any duplicated issues or lock duplicated
|
||||||
|
discussions_. Opening multiple channels to ask the same question or report the
|
||||||
|
same issue across different forums hinders our ability to manage and address
|
||||||
|
community concerns effectively. This approach is vital for efficient time
|
||||||
|
management, as duplicated questions can consume the time of multiple team
|
||||||
|
members simultaneously. Ensuring that each issue or discussion is unique and
|
||||||
|
progresses with new information helps us to maintain focus and support our
|
||||||
|
community.
|
||||||
|
|
||||||
|
We further _reserve the right to immediately close discussions or issues that
|
||||||
|
are reopened without providing new information_ or simply because users have
|
||||||
|
not yet received a response to their issue/question, as the issue is marked as
|
||||||
|
incomplete.
|
||||||
|
|
||||||
|
[minimal reproductions]: ../guides/creating-a-reproduction.md
|
||||||
|
Loading…
Reference in New Issue
Block a user