Skip to content

Commit

Permalink
GH-96 Add git-related files and represent permission section in table. (
Browse files Browse the repository at this point in the history
#104)

* Add git-related files and represent permission section in table.

* Moved `chatformatter.reload` and `chatformatter.receiveupdates` command references

* Update .github/CONTRIBUTING.md

Co-authored-by: Michał Wojtas <[email protected]>

* Update .github/ISSUE_TEMPLATE/bug-report.md

Co-authored-by: Michał Wojtas <[email protected]>

---------

Co-authored-by: Michał Wojtas <[email protected]>
  • Loading branch information
vLuckyyy and CitralFlo authored Nov 20, 2023
1 parent 70618ad commit 303d72d
Show file tree
Hide file tree
Showing 6 changed files with 354 additions and 40 deletions.
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant 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, 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 at
https://discord.gg/FQ7jmGBd6c.
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.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
88 changes: 88 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Contributing to ChatFormatter

:Wave: Hello there!
We wholeheartedly welcome all contributions to ChatFormatter and are excited to know you are considering making one.

To ensure a robust and ideal solution, we recommend going through this guide.
Following this guide saves both your time,
and some of our core contributors are engaged in maintaining the project and reviewing proposals.

## Submitting Bug Reports and Feature Requests

- Before submitting a bug report or a feature request, please ensure you've done a thorough search on
our [Issues tab](https://github.com/EternalCodeTeam/Chatformatter/issues) to ensure it wasn't previously reported or
requested.

- Our [issue template](https://github.com/EternalCodeTeam/Chatformatter/issues/new) is designed to guide you in
submitting
a detailed report, which helps us greatly in understanding, recreating, and addressing the issue.

- For feature proposals, kindly submit them under
our [Issues tab](https://github.com/EternalCodeTeam/Chatformatter/issues)
using the `feature` tag. Describe the feature, specifying why you think it is beneficial. It would be great if you
could elaborate on its expected behavior.

## Building

1. Navigate to the project root directory (i.e., the directory where the repository is cloned).
2. Use Gradle to build the project by typing the following command on your command line:

```bash
gradle shadowAll
```

Your build should be successful, and you should see a JAR file in the `/build/libs` directory.

## Sending a Pull Request

1. For significant changes, open an issue for discussion before starting your work.

2. Fork the repository to your account.

3. Clone the repository:

```bash
git clone https://github.com/your-username/Chatformatter.git
```

4. Create a new branch:

```bash
git checkout -b name-your-branch-here
```

5. Make the necessary changes/additions in the code.

6. Commit the changes:

```bash
git commit -m "Add a detailed commit message here"
```

7. Push the code back to the repository:

```bash
git push origin name-your-branch-here
```

8. Open a pull request (PR) against the `master` branch of our repository. Describe your changes, why you believe they
are necessary, and how they improve the project. Additionally, reference any related issues.

9. Our maintainers will review your PR. We might suggest some changes, improvements or reasoning on why the changes
should be/not being made.

Remember, to code reviews function as a quality control and learning opportunity.
Be receptive to the suggestions made
and committed to making the suggested improvements.

## Code of Conduct

By participating in this project, you are expected to uphold our [Code of Conduct](.github/CODE_OF_CONDUCT.md).

## Getting Help

If you need help with making a contribution or using our project, please feel free to ask on
our [Discord server](https://discord.gg/FQ7jmGBd6c).
We are always happy to assist those who show an endeavor to learn!

Thank you once again for your interest in contributing to Chatformatter and making our project even better!
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug Report
about: Create a detailed report to help us fix a bug
labels: '🐛 bug'
---

# ChatFormatter Bug Report

## Describe the Bug

Please provide a clear and comprehensive description of what the bug is. If possible, include steps to reproduce it.

## Expected Behavior

A description of the expected behavior is requested.

## Screenshots

If applicable, adding screenshots can help to explain the problem.

## Environment Information

- Minecraft Version:
- ChatFormatter Version:
- Server Platform (e.g., Paper, Spigot):
- Server Version:
- Java Version:

## Additional Context

Any additional context, information, or data that might be relevant to this bug report is welcomed here.

**Remember, the more information provided, the more likely the issue can be understood, diagnosed, and effectively
addressed expediently.**
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Feature Request
about: For suggesting an idea for this project
labels: '🆕 feature'
---

# ChatFormatter Feature Request

## Summary

A brief summary of the feature request is desired. Kindly specify the problem it addresses or the value it adds.

## Solution Description

A detailed description of the proposed solution is appreciated.
Details regarding its workings and visual representation are requested.

## Alternatives

Any considerations of alternative solutions or features? If so, their description is appreciated here.

## Additional Context

Any additional information (mock-ups, links to similar solutions in other plugins/games, etc.),
related to the feature request can be provided here.

**Remember, the provision of comprehensive information enhances the understanding and evaluation of the requested
feature.**
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## Description

Please provide a brief summary of the changes made in this PR. Include references to any related issues or discussions,
if relevant.

Example: "This PR resolves issue #10. The issue addressed..."

## What kind of change does this PR introduce? (Check at least one)

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update
- [ ] Refactor
- [ ] Build related changes
- [ ] Documentation code
- [ ] Other, please describe:

Make sure your PR fulfills these requirements:

- [ ] Tests for the changes have been added (where possible)
- [ ] Documentation (README.md, CONTRIBUTING.md) has been updated, if needed
- [ ] All new and existing tests have passed


## Other Information

Please provide any additional information that you think may be relevant to this PR.

## Checklist

By submitting this PR, you confirm that you have completed the following:

- [ ] I have read and understand the [CONTRIBUTING Guide](CONTRIBUTING.md)
- [ ] I have checked that no existing PRs fulfill my requirements and appear to be duplicates
- [ ] The PR title follows the guidelines defined in the contributing guide
- [ ] All tests pass locally with my changes (if applicable)
- [ ] I have performed a self-review of my own code
Loading

0 comments on commit 303d72d

Please sign in to comment.