aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorfatpigsarefat <fatpigsarefat@users.noreply.github.com>2018-07-21 21:48:11 +0100
committerGitHub <noreply@github.com>2018-07-21 21:48:11 +0100
commite662a173daa763ebf6b511d535e5e3822f681711 (patch)
treebac1c4203f939747d393d603f1403412bde7a478
parentbcd4d141c04768c2ed3d00d4963e4f40424b5bc4 (diff)
Added guidelines to README.md
- Added information on using Maven to build Quests. - Added information on how to use the Issue Tracker effectively to communcate bugs. - Made sure to elaborate on how to format files and commit messages.
-rw-r--r--README.md37
1 files changed, 30 insertions, 7 deletions
diff --git a/README.md b/README.md
index 3317fa32..197a8512 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,44 @@
-# Quests
+## About Quests
This plugin will allow your players to do quests in-game to earn rewards. This can all be configured.
-### Downloads
+## Downloads/Building
The latest version of Quests can be found on [Spigot](https://www.spigotmc.org/resources/▶-quests-◀-set-up-goals-for-players.23696/)
-### Authors and Contributors
+Alternatively, you can build Quests via Maven using ``mvn clean package`` (or clicking the appropiate buttons in your IDE).
+## Authors and Contributors
- fatpigsarefat (original author)
- Reinatix (playtime task type)
-### Support
+## Support
For support please open a [GitHub issue](https://github.com/fatpigsarefat/Quests/issues) or join our [Discord server](https://discord.gg/8amrJnX). Please provide information of the issue, any errors that may come up and make sure you are using the latest version of the plugin.
-### Configuration Assistance
+### Issue Tracker
+**This is the perferred method of bug reporting & feature requests**. Please use one of the two templates which are provided. If it is neither a bug report or a feature request and is a question, Discord would be a better place to asked this instead. **Follow the template in the issue tracker**. There is nothing more frustrating than people not reporting a bug correctly by missing out vital steps to reproduce the bug or an incomplete description. If the issue is not correctly formated, it will be closed and ignored.
+
+### Discord
+**This is the perferred method for general questions about Quests or the development of the project**. Join the Discord server and go to the relative support channel (in this case: #quests-support). Please provide steps to reproduce and a good enough description of the bug and include any errors you may see in console.
+
+### Language
+Please speak English and do not use any vulgar or harmful language. Insulting myself or any other contributors will lead to you being blocked, please remember this is a *voulenteer driven project*.
+
+## Configuration Assistance
The configuration documentation can be found at the [wiki](https://github.com/fatpigsarefat/Quests/wiki/Creating-A-Quest-Or-Category).
-### Developing Alongside Quests
+## Developing Alongside Quests
Creating new Task Types within Quests is supported, [see the wiki](https://github.com/fatpigsarefat/Quests/wiki/New-Task-Type) for help.
-### Contributing To Quests
+## Contributing To Quests
Fork and make a pull request. Please be consistent with the formatting of the file, please state what you have changed, please test what you have changed before submitting a pull request to make sure it works. Include your DiscordTag if you want a 'contributors' role in our [Discord server](https://discord.gg/8amrJnX).
+
+### Contribution Guildlines
+Make sure to format your file using *spaces* not *tabs*. This is how the rest of the project is and it will remain that way. When committing, please follow normal convention which is to have a ~50 character summary on the first line, a blank line then (if applicable) a more detailed description either in bullet points (using a dash as the bullet) or as paragraphs.
+
+Example commit message:
+```
+Added guidelines to README.md
+
+- Added information on using Maven to build Quests.
+- Added information on how to use the Issue Tracker effectively to communcate bugs.
+- Made sure to elaborate on how to format files and commit messages.
+```
+Make sure your changes actually work before submitting a pull request by building the project and testing it on a Spigot server using the latest version.