Skip to content

Commit 303d72d

Browse files
vLuckyyyCitralFlo
vLuckyyy
and
CitralFlo
authored
GH-96 Add git-related files and represent permission section in table. (#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]>
1 parent 70618ad commit 303d72d

File tree

6 files changed

+354
-40
lines changed

6 files changed

+354
-40
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
https://discord.gg/FQ7jmGBd6c.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.github/CONTRIBUTING.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Contributing to ChatFormatter
2+
3+
:Wave: Hello there!
4+
We wholeheartedly welcome all contributions to ChatFormatter and are excited to know you are considering making one.
5+
6+
To ensure a robust and ideal solution, we recommend going through this guide.
7+
Following this guide saves both your time,
8+
and some of our core contributors are engaged in maintaining the project and reviewing proposals.
9+
10+
## Submitting Bug Reports and Feature Requests
11+
12+
- Before submitting a bug report or a feature request, please ensure you've done a thorough search on
13+
our [Issues tab](https://github.com/EternalCodeTeam/Chatformatter/issues) to ensure it wasn't previously reported or
14+
requested.
15+
16+
- Our [issue template](https://github.com/EternalCodeTeam/Chatformatter/issues/new) is designed to guide you in
17+
submitting
18+
a detailed report, which helps us greatly in understanding, recreating, and addressing the issue.
19+
20+
- For feature proposals, kindly submit them under
21+
our [Issues tab](https://github.com/EternalCodeTeam/Chatformatter/issues)
22+
using the `feature` tag. Describe the feature, specifying why you think it is beneficial. It would be great if you
23+
could elaborate on its expected behavior.
24+
25+
## Building
26+
27+
1. Navigate to the project root directory (i.e., the directory where the repository is cloned).
28+
2. Use Gradle to build the project by typing the following command on your command line:
29+
30+
```bash
31+
gradle shadowAll
32+
```
33+
34+
Your build should be successful, and you should see a JAR file in the `/build/libs` directory.
35+
36+
## Sending a Pull Request
37+
38+
1. For significant changes, open an issue for discussion before starting your work.
39+
40+
2. Fork the repository to your account.
41+
42+
3. Clone the repository:
43+
44+
```bash
45+
git clone https://github.com/your-username/Chatformatter.git
46+
```
47+
48+
4. Create a new branch:
49+
50+
```bash
51+
git checkout -b name-your-branch-here
52+
```
53+
54+
5. Make the necessary changes/additions in the code.
55+
56+
6. Commit the changes:
57+
58+
```bash
59+
git commit -m "Add a detailed commit message here"
60+
```
61+
62+
7. Push the code back to the repository:
63+
64+
```bash
65+
git push origin name-your-branch-here
66+
```
67+
68+
8. Open a pull request (PR) against the `master` branch of our repository. Describe your changes, why you believe they
69+
are necessary, and how they improve the project. Additionally, reference any related issues.
70+
71+
9. Our maintainers will review your PR. We might suggest some changes, improvements or reasoning on why the changes
72+
should be/not being made.
73+
74+
Remember, to code reviews function as a quality control and learning opportunity.
75+
Be receptive to the suggestions made
76+
and committed to making the suggested improvements.
77+
78+
## Code of Conduct
79+
80+
By participating in this project, you are expected to uphold our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
81+
82+
## Getting Help
83+
84+
If you need help with making a contribution or using our project, please feel free to ask on
85+
our [Discord server](https://discord.gg/FQ7jmGBd6c).
86+
We are always happy to assist those who show an endeavor to learn!
87+
88+
Thank you once again for your interest in contributing to Chatformatter and making our project even better!

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug Report
3+
about: Create a detailed report to help us fix a bug
4+
labels: '🐛 bug'
5+
---
6+
7+
# ChatFormatter Bug Report
8+
9+
## Describe the Bug
10+
11+
Please provide a clear and comprehensive description of what the bug is. If possible, include steps to reproduce it.
12+
13+
## Expected Behavior
14+
15+
A description of the expected behavior is requested.
16+
17+
## Screenshots
18+
19+
If applicable, adding screenshots can help to explain the problem.
20+
21+
## Environment Information
22+
23+
- Minecraft Version:
24+
- ChatFormatter Version:
25+
- Server Platform (e.g., Paper, Spigot):
26+
- Server Version:
27+
- Java Version:
28+
29+
## Additional Context
30+
31+
Any additional context, information, or data that might be relevant to this bug report is welcomed here.
32+
33+
**Remember, the more information provided, the more likely the issue can be understood, diagnosed, and effectively
34+
addressed expediently.**

‎.github/ISSUE_TEMPLATE/feature-request.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature Request
3+
about: For suggesting an idea for this project
4+
labels: '🆕 feature'
5+
---
6+
7+
# ChatFormatter Feature Request
8+
9+
## Summary
10+
11+
A brief summary of the feature request is desired. Kindly specify the problem it addresses or the value it adds.
12+
13+
## Solution Description
14+
15+
A detailed description of the proposed solution is appreciated.
16+
Details regarding its workings and visual representation are requested.
17+
18+
## Alternatives
19+
20+
Any considerations of alternative solutions or features? If so, their description is appreciated here.
21+
22+
## Additional Context
23+
24+
Any additional information (mock-ups, links to similar solutions in other plugins/games, etc.),
25+
related to the feature request can be provided here.
26+
27+
**Remember, the provision of comprehensive information enhances the understanding and evaluation of the requested
28+
feature.**

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Description
2+
3+
Please provide a brief summary of the changes made in this PR. Include references to any related issues or discussions,
4+
if relevant.
5+
6+
Example: "This PR resolves issue #10. The issue addressed..."
7+
8+
## What kind of change does this PR introduce? (Check at least one)
9+
10+
- [ ] Bugfix
11+
- [ ] Feature
12+
- [ ] Code style update
13+
- [ ] Refactor
14+
- [ ] Build related changes
15+
- [ ] Documentation code
16+
- [ ] Other, please describe:
17+
18+
Make sure your PR fulfills these requirements:
19+
20+
- [ ] Tests for the changes have been added (where possible)
21+
- [ ] Documentation (README.md, CONTRIBUTING.md) has been updated, if needed
22+
- [ ] All new and existing tests have passed
23+
24+
25+
## Other Information
26+
27+
Please provide any additional information that you think may be relevant to this PR.
28+
29+
## Checklist
30+
31+
By submitting this PR, you confirm that you have completed the following:
32+
33+
- [ ] I have read and understand the [CONTRIBUTING Guide](CONTRIBUTING.md)
34+
- [ ] I have checked that no existing PRs fulfill my requirements and appear to be duplicates
35+
- [ ] The PR title follows the guidelines defined in the contributing guide
36+
- [ ] All tests pass locally with my changes (if applicable)
37+
- [ ] I have performed a self-review of my own code

0 commit comments

Comments
 (0)