mirror of
https://github.com/StarWishsama/Slimefun4.git
synced 2024-09-19 19:25:48 +00:00
[CI skip] Added emojis to CONTRIBUTING.md
This commit is contained in:
parent
363462095d
commit
d0434de4d5
12
.github/CONTRIBUTING.md
vendored
12
.github/CONTRIBUTING.md
vendored
@ -3,7 +3,7 @@ This document outlines various ways how you can help contribute to Slimefun and
|
||||
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
|
||||
## :beetle: 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.
|
||||
|
||||
@ -15,7 +15,7 @@ If you encounter an issue which has already been reported, please don't open a n
|
||||
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.
|
||||
The more context and information we get, the easier we can fix it.
|
||||
|
||||
## 2. Pull Requests: Bug Fixes
|
||||
## :hammer_and_wrench: 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/Slimefun/Slimefun4/issues) is waiting to be fixed.
|
||||
|
||||
@ -23,7 +23,7 @@ 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/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
|
||||
## :toolbox: 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/Slimefun/Slimefun4#discord) and share your ideas first, we hate to reject changes because the community disagrees.<br>
|
||||
@ -36,7 +36,7 @@ Therefore our `#approved` is a great place to start looking for ideas on what to
|
||||
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/Slimefun/Slimefun4/wiki/Developer-Guide) for a guide on how to create a Slimefun addon..
|
||||
|
||||
## 4. Pull Requests: Translations
|
||||
## :earth_africa: 4. Pull Requests: Translations
|
||||
Another great way to contribute to Slimefun is by working on translations for the project.
|
||||
Slimefun's translation is available on [gitlocalize.com](https://gitlocalize.com/repo/3841).
|
||||
Just find a language you are fluent in and translate away. But make sure to submit a "Review Request" when you are done.
|
||||
@ -48,7 +48,7 @@ Language Moderators are responsible for proof-reading any new translations for t
|
||||
|
||||
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
|
||||
## :scroll: 5. Pull Requests: Wiki contributions
|
||||
Slimefun is a very large project and might be quite intimidating for new players.
|
||||
That's why good documentation is always nice and helpful.
|
||||
If you have played with Slimefun for a while and gotten yourself familiar with how things work, please consider contributing your experiences and knowledge to others via the wiki!
|
||||
@ -57,7 +57,7 @@ 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/Slimefun/Slimefun4/wiki/Expanding-the-Wiki
|
||||
|
||||
## 6. Pull Requests: Code Quality
|
||||
## :star: 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.
|
||||
|
Loading…
Reference in New Issue
Block a user