1
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-19 11:15:51 +00:00

[CI skip] Moved Slimefun repository

This commit is contained in:
TheBusyBiscuit 2020-09-06 17:19:17 +02:00
parent 5c0aba7692
commit cd84930391
11 changed files with 30 additions and 26 deletions

View File

@ -7,8 +7,8 @@
This document should serve the purpose of outlining the behaviour we expect from any participant of the project.
## Scope
This Code of Conduct applies to all sections of the [Slimefun4 GitHub repository](https://github.com/TheBusyBiscuit/Slimefun4), our [Slimefun GitHub organization](https://github.com/Slimefun) and all repositories owned by said organization.<br>
For our official Discord server, please refer to our article on [Discord Rules](https://github.com/TheBusyBiscuit/Slimefun4/wiki/Discord-Rules).
This Code of Conduct applies to all sections of the [Slimefun4 GitHub repository](https://github.com/Slimefun/Slimefun4), our [Slimefun GitHub organization](https://github.com/Slimefun) and all repositories owned by said organization.<br>
For our official Discord server, please refer to our article on [Discord Rules](https://github.com/Slimefun/Slimefun4/wiki/Discord-Rules).
Everyone who engages with this project on any of these repositories is expected to follow the Code of Conduct.<br>
This includes maintainers, contributors, sponsors and anyone who engages in the "Issues" section on GitHub.
@ -18,8 +18,8 @@ This is an Open-Source project, anyone is welcome to engage and contribute!<br>
We generally expect users to engage in the Issues section by reporting bugs or commenting on bug reports to give additional context, help, guidance or to propose possible solutions and fixes.
Pull Requests are very much welcome and encouraged! They keep the project alive, so if you see an Issue and know how to fix it, feel free to create a Pull Request!
Issues that are considered "good first issues", indicated by the [good first issue](https://github.com/TheBusyBiscuit/Slimefun4/labels/good%20first%20issue) label, are generally expected to be beginner-friendly.
And even if you shouldn't know where to start or how to proceed, our [Discord Server](https://github.com/TheBusyBiscuit/Slimefun4#discord) and its community will be there for you!
Issues that are considered "good first issues", indicated by the [good first issue](https://github.com/Slimefun/Slimefun4/labels/good%20first%20issue) label, are generally expected to be beginner-friendly.
And even if you shouldn't know where to start or how to proceed, our [Discord Server](https://github.com/Slimefun/Slimefun4#discord) and its community will be there for you!
When commenting, please keep in mind that this software is offered for **free**. Don't expect to receive lightning-fast replies 24 hours a day.
Everyone here works on this project in their free time and usually has work, school, university or family to take care of, so we appreciate patience and understanding.
@ -59,7 +59,7 @@ https://github.com/orgs/Slimefun/people
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders (labelled on Discord as "Admins" or "Moderators") responsible for enforcement on our [Discord Server](https://github.com/TheBusyBiscuit/Slimefun4#discord).
reported to the community leaders (labelled on Discord as "Admins" or "Moderators") responsible for enforcement on our [Discord Server](https://github.com/Slimefun/Slimefun4#discord).
If you want your issue to be handled discreetly, message `TheBusyBiscuit#2610` or `Walshy#9709` privately on Discord and state your concerns.
All complaints will be reviewed and investigated promptly and fairly.

View File

@ -1,15 +1,15 @@
# Contributing to Slimefun
This document outlines various ways how you can help contribute to Slimefun and make this a bigger and better project.<br>
All contributions must be inline with our [Code of Conduct](https://github.com/TheBusyBiscuit/Slimefun4/blob/master/.github/CODE_OF_CONDUCT.md) and [License](https://github.com/TheBusyBiscuit/Slimefun4/blob/master/LICENSE).
All contributions must be inline with our [Code of Conduct](https://github.com/Slimefun/Slimefun4/blob/master/.github/CODE_OF_CONDUCT.md) and [License](https://github.com/Slimefun/Slimefun4/blob/master/LICENSE).
Please also follow the templates for Issues and Pull Requests we provide.
## 1. Issues: Bug Reports
One of the foundations for good software is reliability. To facilitate this reliability, our community must work together to crush bugs that arise.
This of course requires good information and knowledge about ongoing bugs and issues though.
You can help this project by reporting a bug on our [Issues Tracker](https://github.com/TheBusyBiscuit/Slimefun4/issues).<br>
You can help this project by reporting a bug on our [Issues Tracker](https://github.com/Slimefun/Slimefun4/issues).<br>
Please adhere to the provided template and provide as much information as possible.
For more info on how to make good and helpful bug reports, check out our article on [How to report bugs](https://github.com/TheBusyBiscuit/Slimefun4/wiki/How-to-report-bugs).
For more info on how to make good and helpful bug reports, check out our article on [How to report bugs](https://github.com/Slimefun/Slimefun4/wiki/How-to-report-bugs).
If you encounter an issue which has already been reported, please don't open a new one.<br>
It would be awesome though if you could post a comment on the existing issue which explains how you were able to reproduce this yourself.
@ -17,16 +17,16 @@ The more context and information we get, the easier we can fix it.
## 2. Pull Requests: Bug Fixes
Bugs that have been reported need to be fixed of course.<br>
Any open Issue on our [Issues Tracker](https://github.com/TheBusyBiscuit/Slimefun4/issues) is waiting to be fixed.
Any open Issue on our [Issues Tracker](https://github.com/Slimefun/Slimefun4/issues) is waiting to be fixed.
This is an Open-Source project and we love Pull Requests.
So if you have an idea on how to approach a known issue, feel free to make a [Pull Request](https://github.com/TheBusyBiscuit/Slimefun4/pulls) which fixes this bug.
So if you have an idea on how to approach a known issue, feel free to make a [Pull Request](https://github.com/Slimefun/Slimefun4/pulls) which fixes this bug.
You can also comment on the existing Issue, proposing your idea or communicating that you wanna work on this.
## 3. Pull Requests: Additions/Changes
Slimefun is an Open-Source project and anyone is allowed to make changes or add content to this plugin!
Please visit our [Discord Server](https://github.com/TheBusyBiscuit/Slimefun4#discord) and share your ideas first, we hate to reject changes because the community disagrees.<br>
Please visit our [Discord Server](https://github.com/Slimefun/Slimefun4#discord) and share your ideas first, we hate to reject changes because the community disagrees.<br>
So communicating your intended changes before-hand will ensure that you don't put too much work into something that might get rejected.
We also have a suggestions section in our Discord Server too. Suggestions can be placed in the `#suggestions` channel and community members can vote on a suggestion.
@ -34,7 +34,7 @@ Suggestions which gotten enough votes will be moved to `#approved`.
Therefore our `#approved` is a great place to start looking for ideas on what to add or change, since it will definitely be something a large number of people agree with.
Also consider making an addon for your additions when they get too large, too abstract or too "niche".
You can check out our [Developer Guide](https://github.com/TheBusyBiscuit/Slimefun4/wiki/Developer-Guide) for a guide on how to create a Slimefun addon..
You can check out our [Developer Guide](https://github.com/Slimefun/Slimefun4/wiki/Developer-Guide) for a guide on how to create a Slimefun addon..
## 4. Pull Requests: Translations
Another great way to contribute to Slimefun is by working on translations for the project.
@ -46,7 +46,7 @@ One of our Language Moderators will review the changes and submit a Pull Request
Very active community translators will have the option to become a "Language Moderator".
Language Moderators are responsible for proof-reading any new translations for their designated language and correct it when they see a mistake.
For more info on how or what to translate, check out our article on [How to translate Slimefun](https://github.com/TheBusyBiscuit/Slimefun4/wiki/Translating-Slimefun).
For more info on how or what to translate, check out our article on [How to translate Slimefun](https://github.com/Slimefun/Slimefun4/wiki/Translating-Slimefun).
## 5. Pull Requests: Wiki contributions
Slimefun is a very large project and might be quite intimidating for new players.
@ -55,14 +55,14 @@ If you have played with Slimefun for a while and gotten yourself familiar with h
It would help out a lot :heart:
You can find a tutorial on how to contribute to our wiki right here:<br>
https://github.com/TheBusyBiscuit/Slimefun4/wiki/Expanding-the-Wiki
https://github.com/Slimefun/Slimefun4/wiki/Expanding-the-Wiki
## 6. Pull Requests: Code Quality
Slimefun uses [sonarcloud.io](https://sonarcloud.io/dashboard?id=TheBusyBiscuit_Slimefun4) to monitor Code Quality.
We always welcome quality improvements to the code and the "Code Smells" section on [sonarcloud.io](https://sonarcloud.io/dashboard?id=TheBusyBiscuit_Slimefun4) is a great place to start.
But please keep in mind that some design patterns may not be changed too abruptly if an addon depends on them.
To prevent any accidents from happening, please contact us on our [Discord Server](https://github.com/TheBusyBiscuit/Slimefun4#discord) before-hand and state your intended changes.
To prevent any accidents from happening, please contact us on our [Discord Server](https://github.com/Slimefun/Slimefun4#discord) before-hand and state your intended changes.
#### Documentation
Code documentation is also a great way to improve the maintainability of the project.
@ -73,7 +73,7 @@ Feel free to visit our [Javadocs](https://slimefun.github.io/javadocs/Slimefun4/
#### Unit Tests
Unit Tests help us test the project to work as intended in an automated manner.<br>
More or better Unit Tests are always good to have, so feel free to submit a Test and place it in our [src/test/java](https://github.com/TheBusyBiscuit/Slimefun4/tree/master/src/test/java/io/github/thebusybiscuit/slimefun4/testing) directory
More or better Unit Tests are always good to have, so feel free to submit a Test and place it in our [src/test/java](https://github.com/Slimefun/Slimefun4/tree/master/src/test/java/io/github/thebusybiscuit/slimefun4/testing) directory
We are using [Junit 5 - Jupiter](https://github.com/junit-team/junit5/) and [MockBukkit](https://github.com/seeseemelk/MockBukkit) as our testing environment.<br>
Every new Unit Test should have a "DisplayName" annotation with a plain text description on what the Unit Test tests.

View File

@ -1,3 +1,3 @@
THIS ISSUE IS INVALID.
TO REPORT A BUG, GO HERE -> https://github.com/TheBusyBiscuit/Slimefun4/issues/new/choose
TO REPORT A BUG, GO HERE -> https://github.com/Slimefun/Slimefun4/issues/new/choose

View File

@ -1,8 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Bug Report Guidelines
url: https://github.com/TheBusyBiscuit/Slimefun4/wiki/How-to-report-bugs
- name: Code of Conduct
url: https://github.com/Slimefun/Slimefun4/blob/master/.github/CODE_OF_CONDUCT.md
about: Please read this before posting
- name: Bug Report Guidelines
url: https://github.com/Slimefun/Slimefun4/wiki/How-to-report-bugs
about: Guidelines on how to make good Bug reports
- name: Discord Server (for Questions and Suggestions)
url: https://discord.gg/fsD4Bkh
about: Please ask and answer questions here.

View File

@ -31,7 +31,7 @@ jobs:
issue_number: ${{ github.event.issue.number }}
body: |-
Your issue seems to be missing our template.
[Click here to create a bug report](https://github.com/TheBusyBiscuit/Slimefun4/issues/new/choose)
[Click here to create a bug report](https://github.com/Slimefun/Slimefun4/issues/new/choose)
Please remember that this Bug Tracker is exclusively reserved for Bug reports, any other form
of discussion, like suggestions or questions should be posted on our discord server (You can find a link [on our main page](https://github.com/TheBusyBiscuit/Slimefun4#discord)).
of discussion, like suggestions or questions should be posted on our discord server (You can find a link [on our main page](https://github.com/Slimefun/Slimefun4#discord)).

View File

@ -54,4 +54,4 @@ jobs:
Please respond below, if you have any further questions.
Do **not** open a new Issue unless explicitly told otherwise, comment below or edit your post instead.<br>
Make sure to check out our article on [How to report bugs](https://github.com/TheBusyBiscuit/Slimefun4/wiki/How-to-report-bugs) for even more information.
Make sure to check out our article on [How to report bugs](https://github.com/Slimefun/Slimefun4/wiki/How-to-report-bugs) for even more information.

View File

@ -11,7 +11,7 @@ jobs:
name: Discord Webhook
runs-on: ubuntu-latest
if: github.repository == 'TheBusyBiscuit/Slimefun4'
if: github.repository == 'Slimefun/Slimefun4'
steps:
- name: Checkout repository

View File

@ -11,6 +11,7 @@ jobs:
runs-on: ubuntu-latest
if: contains(github.event.comment.body, 'Duplicate of ')
steps:
- name: Add label to the Issue
uses: maxkomarychev/octions/octions/issues/add-labels@master

View File

@ -12,7 +12,7 @@ jobs:
name: Translation-Notifier
runs-on: ubuntu-latest
if: github.repository == 'TheBusyBiscuit/Slimefun4'
if: github.repository == 'Slimefun/Slimefun4'
steps:
- name: Discord Notification

View File

@ -12,7 +12,7 @@ jobs:
name: Changelog Generator
runs-on: ubuntu-latest
if: github.repository == 'TheBusyBiscuit/Slimefun4'
if: github.repository == 'Slimefun/Slimefun4'
steps:
- name: TOC Generator

View File

@ -18,7 +18,7 @@ jobs:
- name: URL-checker
uses: SuperKogito/URLs-checker@0.2.1
with:
git_path: https://github.com/TheBusyBiscuit/Slimefun4
git_path: https://github.com/Slimefun/Slimefun4
file_types: .md,.java,.yml
print_all: False
retry_count: 2