summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSkyBirdSoar <SkyBirdSoar@users.noreply.github.com>2014-01-01 16:38:19 +0800
committerKHobbits <rob@khobbits.co.uk>2014-03-04 19:26:16 +0000
commita493fc491af01832f7be6eed9b16734ba73635e2 (patch)
tree178b6f35e7915820fe052dde5a3c2c6cfe9f3c39
parent0c20f986705f2514a16886e38559f3a6e7aeb531 (diff)
downloadEssentials-a493fc491af01832f7be6eed9b16734ba73635e2.tar
Essentials-a493fc491af01832f7be6eed9b16734ba73635e2.tar.gz
Essentials-a493fc491af01832f7be6eed9b16734ba73635e2.tar.lz
Essentials-a493fc491af01832f7be6eed9b16734ba73635e2.tar.xz
Essentials-a493fc491af01832f7be6eed9b16734ba73635e2.zip
Fixed some grammatic errors, changed some sentences.
-rw-r--r--README.markdown16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.markdown b/README.markdown
index b0de21483..ae9dc1fad 100644
--- a/README.markdown
+++ b/README.markdown
@@ -31,11 +31,11 @@ Commit Guidelines
Commits should fall into one of 3 areas:
-[Feature] Commits which are features should start with '[Feature]' and followed by a quick summary on the top line, followed by some extra details in the commit body.
+- `[Feature]`: Commits which are features should start with `[Feature]` and followed by a quick summary on the top line, followed by some extra details in the commit body.
-[Fix] Commits which fix bugs, or minor improvements to existing features should start with '[Fix]' and followed by a quick summary on the top line, followed by some extra details in the commit body.
+- `[Fix]`: Commits which fix bugs, or minor improvements to existing features should start with `[Fix]` and followed by a quick summary on the top line, followed by some extra details in the commit body.
-Commits which fix bugs caused by previous commits (since last release), or otherwise make no functionality changes, should have no prefix. These will not be added to the project change log.
+- Commits which fix bugs caused by previous commits (since last release), or otherwise make no functionality changes, should have no prefix. These will not be added to the project change log.
Coding Guidelines
-----------------
@@ -44,18 +44,18 @@ Coding Guidelines
Please follow the format guidelines that are saved in the project properties.
Windows users, please read this: http://help.github.com/line-endings/
-The default line ending is LF.
+The default line ending is **LF**.
To build all jars, select the EssentialsParent project and build that. You'll find all jars inside the jars folder.
-If you create pull requests, always make them for the 2.x branch.
+Please only submit pull requests for the 2.x branch.
-The essentials bug tracker can be found at https://essentials3.atlassian.net/
+Bugs and issues can be submitted at https://essentials3.atlassian.net/
Other advice
-----------------
-Not all features are 'Essentials Ready'. Essentials is designed to be cover the basic needs of Minecraft server administration, for this reason, we reject over 80% of feature requests.
+Not all features are 'Essentials Ready'. Essentials is designed to cover the basic needs of Minecraft server administration, thus, we reject over 80% of feature requests that we deem are unsuitable.
-Before developing an Essentials feature, we would recommend speaking to a developer in the Essentials IRC channel (#essentials on irc.esper.net).
+Before developing an Essentials feature, we would recommend speaking to a developer in the Essentials IRC channel ([#essentials on irc.esper.net](http://tiny.cc/EssentialsChat)). Click [here](irc://irc.esper.net/#essentials) if you have a IRC client.