mirror of
https://github.com/PlayPro/CoreProtect.git
synced 2024-12-01 13:23:26 +01:00
152 lines
6.7 KiB
Markdown
152 lines
6.7 KiB
Markdown
# Contributing
|
||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||
on Discord, or any other method with the owners of this repository before making a change.
|
||
|
||
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||
|
||
## Pull Request Guidelines
|
||
|
||
- For consistency, please only use spaces for indentation.
|
||
- Use descriptiveCamelCase for variable/method names. Names containing underscore or abbreviations should be changed.
|
||
- Restrict changes in a commit to a single event or section of code (e.g. refactor BlockBreakEvent and BlockPlaceEvent in separate commits)
|
||
- Attempt to keep the amount of code modified in a single pull request small and readable.
|
||
- Please utilize [SonarLint](https://www.sonarlint.org) in your IDE. Contributions are automatically analyzed.
|
||
- When adding new functionality, please also be sure to update the documentation as well.
|
||
- Use common sense. If you have a suggestion for a contribution guideline, post it on Discord.
|
||
|
||
Please note that although numerous improvements have been made to the codebase over the past few years, there’s still significant work to be done. Parts of this plugin are over a decade old, and new functionality is continuously being added. Refactoring is welcomed, but please be sure to keep commits a reasonable size.
|
||
|
||
## Code of Conduct
|
||
|
||
### Our Pledge
|
||
|
||
We as members, contributors, and leaders pledge to make participation in our
|
||
community a harassment-free experience for everyone, regardless of age, body
|
||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||
identity and expression, level of experience, education, socio-economic status,
|
||
nationality, personal appearance, race, caste, color, religion, or sexual identity
|
||
and orientation.
|
||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||
diverse, inclusive, and healthy community.
|
||
|
||
### Our Standards
|
||
|
||
Examples of behavior that contributes to a positive environment for our
|
||
community include:
|
||
|
||
* Demonstrating empathy and kindness toward other people
|
||
* Being respectful of differing opinions, viewpoints, and experiences
|
||
* Giving and gracefully accepting constructive feedback
|
||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||
and learning from the experience
|
||
* Focusing on what is best not just for us as individuals, but for the
|
||
overall community
|
||
|
||
Examples of unacceptable behavior include:
|
||
|
||
* The use of sexualized language or imagery, and sexual attention or
|
||
advances of any kind
|
||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||
* Public or private harassment
|
||
* Publishing others' private information, such as a physical or email
|
||
address, without their explicit permission
|
||
* Other conduct which could reasonably be considered inappropriate in a
|
||
professional setting
|
||
|
||
### Enforcement Responsibilities
|
||
|
||
Community leaders are responsible for clarifying and enforcing our standards of
|
||
acceptable behavior and will take appropriate and fair corrective action in
|
||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||
or harmful.
|
||
|
||
Community leaders have the right and responsibility to remove, edit, or reject
|
||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||
decisions when appropriate.
|
||
|
||
### Scope
|
||
|
||
This Code of Conduct applies within all community spaces, and also applies when
|
||
an individual is officially representing the community in public spaces.
|
||
Examples of representing our community include using an official e-mail address,
|
||
posting via an official social media account, or acting as an appointed
|
||
representative at an online or offline event.
|
||
|
||
### Enforcement
|
||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||
reported to the community leaders responsible for enforcement on our Discord server, at
|
||
[discord.gg/b4DZ4jy](https://discord.gg/b4DZ4jy).
|
||
All complaints will be reviewed and investigated promptly and fairly.
|
||
|
||
All community leaders are obligated to respect the privacy and security of the
|
||
reporter of any incident.
|
||
|
||
### Enforcement Guidelines
|
||
|
||
Community leaders will follow these Community Impact Guidelines in determining
|
||
the consequences for any action they deem in violation of this Code of Conduct:
|
||
|
||
#### 1. Correction
|
||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||
unprofessional or unwelcome in the community.
|
||
|
||
**Consequence**: A private, written warning from community leaders, providing
|
||
clarity around the nature of the violation and an explanation of why the
|
||
behavior was inappropriate. A public apology may be requested.
|
||
|
||
#### 2. Warning
|
||
|
||
**Community Impact**: A violation through a single incident or series
|
||
of actions.
|
||
|
||
**Consequence**: A warning with consequences for continued behavior. No
|
||
interaction with the people involved, including unsolicited interaction with
|
||
those enforcing the Code of Conduct, for a specified period of time. This
|
||
includes avoiding interactions in community spaces as well as external channels
|
||
like social media. Violating these terms may lead to a temporary or
|
||
permanent ban.
|
||
|
||
#### 3. Temporary Ban
|
||
|
||
**Community Impact**: A serious violation of community standards, including
|
||
sustained inappropriate behavior.
|
||
|
||
**Consequence**: A temporary ban from any sort of interaction or public
|
||
communication with the community for a specified period of time. No public or
|
||
private interaction with the people involved, including unsolicited interaction
|
||
with those enforcing the Code of Conduct, is allowed during this period.
|
||
Violating these terms may lead to a permanent ban.
|
||
|
||
#### 4. Permanent Ban
|
||
|
||
**Community Impact**: Demonstrating a pattern of violation of community
|
||
standards, including sustained inappropriate behavior, harassment of an
|
||
individual, or aggression toward or disparagement of classes of individuals.
|
||
|
||
**Consequence**: A permanent ban from any sort of public interaction within
|
||
the community.
|
||
|
||
### Attribution
|
||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||
version 2.0, available at
|
||
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||
|
||
Community Impact Guidelines were inspired by
|
||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||
|
||
For answers to common questions about this code of conduct, see the FAQ at
|
||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||
at [https://www.contributor-covenant.org/translations][translations].
|
||
|
||
[homepage]: https://www.contributor-covenant.org
|
||
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||
[FAQ]: https://www.contributor-covenant.org/faq
|
||
[translations]: https://www.contributor-covenant.org/translations
|