1
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-20 03:35:51 +00:00
Slimefun4/.github/CONTRIBUTING.md
2017-04-26 20:43:44 +02:00

4.2 KiB

Slimefun Community Guidelines

Slimefun is a community project, everyone is welcome to open Issues, make Pull Requests or make Pull Requests for an opened Issue. Without your help, this project is going to die.

General Guidelines

Rules for all types of posts:

  1. Follow our Templates for Issues and Pull Request, they are designed to tell you what exact Information we need and how you should present it to us.
  2. Be nice and give constructive critism. Insulting, Harassment, Racism, Sexism or any form of bullying or discrimination is not tolerated.
  3. Try to engage in conversations by pointing out scenarios to replicate Issues, providing fix approaches or other kind of help.
  4. Advertisement is inappropriate and will be removed, especially advertisement for Minecraft Servers is completely unaccepted.

GitHub Issues

Rules for posting an Issue on GitHub:

  1. This Issue Section is ONLY for Slimefun-related Issues, Issues about other Plugins or Slimefun Addons should not be posted here.
  2. Please consult our Troubleshooting Guide before posting.
  3. Check other Issues before posting to make sure you are not posting a duplicate.
  4. Do not put any Tags inside your title like [IMPORTANT], [URGENT] or [SUGGESTION]. Try to be professional by making your title as short as possible, we will assign it the required labels if necessary.
  5. Do not post your Issue more than once, this is considered spam and does not benefit our community in any way. Do not repost your Issue if it was closed either.
  6. Give us all available information right away, it may be a bit of time-wasting for us to keep asking for more Info. And this includes any Information to reproduce your Issue step-by-step.
  7. Check whether there are newer versions available than the ones you are using, it might be that your Issue has been fixed already.
  8. All text logs must be posted via a link to http://pastebin.com or similiar websites.

Your Issue will be CLOSED WITHOUT WARNING if we think you violated these Rules.

Pull Requests

Guidelines for making a Pull Request on GitHub:

  1. Try to be reasonable with your additions. No, a Bacon flavoured unicorn that flies on a rainbow while dancing Gangnam Style is NOT a reasonable addition to this Project.
  2. Try to make your values configurable in the config.yml / Items.yml or any additional file. This may not be necessary at every instance but it does give the end-users a way to customize their experience.
  3. If your Pull Request is made in response to an Issue opened on GitHub, comment on that Issue and reference your Pull Request to show that you are proposing a fix for it.

Troubleshooting Guide

Step 1: Check whether you have installed Slimefun correctly

Slimefun requires CS-CoreLib to run. If it has not been installed automatically for you, then please download & install it manually.

Step 2: Check whether you are running on the latest Versions

Both, Slimefun and CS-CoreLib are updated from time to time. You should be sure that you run the latest Versions (at the time you post your Issue) of both Plugins.

Step 3: Does it have to do with Items called 'CS-CoreLib's Head'?

Well in that case, you have been the victim of corruption, unless you have an Error/Crash Report that we can work with, there is literally nothing we can do about it. Corrupting Files/Data can happen from time to time and getting completely rid of it would require a ton of work and even then it is still not completely impossible to occur.

Step 4: Do you get an Error, do you have an Error Report?

Check your /plugins/Slimefun/error-reports/ directory and if it contains any Files, then please upload those to http://pastebin.com and provide us with a link.

When providing us Errors from your Server Log MAKE SURE THEY ARE ERRORS. It has happened more often than you may think that people send us messages. Try to read the suspected 'Error' before uploading it to http://pastebin.com If it says "Please install CS-CoreLib", then you may want to rethink whether you want to ask us what it means...