Updated README & added contributing guidelines
This commit is contained in:
parent
7c2f87fa1f
commit
d51968ef7c
2 changed files with 191 additions and 4 deletions
148
CONTRIBUTING.md
Normal file
148
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,148 @@
|
||||||
|
# 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 refactored in a single commit small and readable.
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
## 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
|
||||||
47
README.md
47
README.md
|
|
@ -1,4 +1,10 @@
|
||||||
CoreProtect
|

|
||||||
|
|
||||||
|
[](License)
|
||||||
|
[](https://discord.gg/b4DZ4jy)
|
||||||
|
[](https://app.netlify.com/sites/coreprotect/deploys)
|
||||||
|
|
||||||
|
CoreProtect 
|
||||||
===========
|
===========
|
||||||
|
|
||||||
CoreProtect is a blazing fast data logging and anti-griefing tool for Minecraft servers.
|
CoreProtect is a blazing fast data logging and anti-griefing tool for Minecraft servers.
|
||||||
|
|
@ -6,11 +12,44 @@ CoreProtect is a blazing fast data logging and anti-griefing tool for Minecraft
|
||||||
**Support and Discussion:**
|
**Support and Discussion:**
|
||||||
- [Discord](https://discord.gg/b4DZ4jy) | [SpigotMC](https://www.spigotmc.org/threads/coreprotect.73929/page-9999)
|
- [Discord](https://discord.gg/b4DZ4jy) | [SpigotMC](https://www.spigotmc.org/threads/coreprotect.73929/page-9999)
|
||||||
|
|
||||||
|
**Patreon:**
|
||||||
|
- [patreon.com/coreprotect](https://www.patreon.com/coreprotect)
|
||||||
|
|
||||||
|
**Downloads:**
|
||||||
|
- [coreprotect.net/download](https://coreprotect.net/download)
|
||||||
|
|
||||||
**Documentation:**
|
**Documentation:**
|
||||||
- [docs.coreprotect.net](http://docs.coreprotect.net)
|
- [docs.coreprotect.net](https://docs.coreprotect.net)
|
||||||
|
|
||||||
|
bStats
|
||||||
|
------
|
||||||
|
[](https://bstats.org/plugin/bukkit/CoreProtect)
|
||||||
|
|
||||||
|
API
|
||||||
|
------
|
||||||
|
### [API Documentation](https://docs.coreprotect.net/api/)
|
||||||
|
|
||||||
|
### Dependency Information
|
||||||
|
Maven
|
||||||
|
```xml
|
||||||
|
<repository>
|
||||||
|
<id>playpro-repo</id>
|
||||||
|
<url>https://maven.playpro.com</url>
|
||||||
|
</repository>
|
||||||
|
```
|
||||||
|
```xml
|
||||||
|
<dependency>
|
||||||
|
<groupId>net.coreprotect</groupId>
|
||||||
|
<artifactId>coreprotect</artifactId>
|
||||||
|
<version>20.0</version>
|
||||||
|
<scope>provided</scope>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
------
|
------
|
||||||
This project is still under development, and is not yet ready for testing or contributions.
|
CoreProtect is an open source project, and gladly accepts community contributions.
|
||||||
|
|
||||||
[](https://app.netlify.com/sites/coreprotect/deploys)
|
If you'd like to contribute, please read our contributing guidelines here: [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||||
|
|
||||||
|
[](CONTRIBUTING.md#code-of-conduct)
|
||||||
Loading…
Add table
Add a link
Reference in a new issue