From dbe5e9b4e9cc7b52ff2b65715f993069b8837dc7 Mon Sep 17 00:00:00 2001 From: Michael Yoo Date: Mon, 14 Jul 2014 17:25:28 +0930 Subject: [PATCH] Remove informal language from Contributing Guidelines --- CONTRIBUTING.md | 35 +++++++++++++++-------------------- 1 file changed, 15 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5388063cd..44b79396d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,33 +2,30 @@ # PocketMine-MP Contribution Guidelines -Before contributing to PocketMine-MP, please read this. Also, take a look if your contribution fits the PocketMine-MP goals below. - +You must follow these guidelines if you wish to contribute to the PocketMine-MP code base, or participate in issue tracking. ## I have a question * For questions, please refer to the _#pocketmine_ or _#mcpedevs_ IRC channel on Freenode. There is a [WebIRC](http://webchat.freenode.net?channels=pocketmine,mcpedevs&uio=d4) if you want. * You can ask directly to _[@PocketMine](https://twitter.com/PocketMine)_ in Twitter, but don't expect an inmediate reply. +* You may use our [Forum](http://forums.pocketmine.net) to ask questions. +* We do not accept questions or support requests in our issue trcker. -## I want to create an issue -* First, use the [Issue Search](https://github.com/PocketMine/PocketMine-MP/search?ref=cmdform&type=Issues) to check if anyone has reported it. -* Is your issue related to a Plugin? If so, please contact their original author instead of reporting it here. - * And no, we won't update a Plugin because you need it. -* When reporting, give as much info as you can, and if the Issue is a crash, give the Crash Dump. -* Issues should be written in English. +## Creating an Issue + - First, use the [Issue Search](https://github.com/PocketMine/PocketMine-MP/search?ref=cmdform&type=Issues) to check if anyone has reported it. + - If your issue is related to a plugin, you must contact their original author instead of reporting it here. + - **Support requests are not bugs.** Issues such as "How do I do this" are not bugs and are closed as soon as a collaborator spots it. They are referred to our Forum to seek assistance. + - ** No generic titles** such as "Question", "Help", "Crash Report" etc. If an issue has a generic title they will either be closed on the spot, or a collaborator will edit it to describe the actual symptom. + - Similarly, no generic issue reports. It is the issue submitter's responsibility to provide us an issue that is **trackable, debuggable, reproducible, reported professionally and is an actual bug**. If you do not provide us with a summary or instructions on how to reproduce the issue, it is a support request until the actual bug has been found and therefore the issue is closed. -## I want a new feature / I want to contribute code +## Contributing Code * Use the [Pull Request](https://github.com/PocketMine/PocketMine-MP/pull/new) system, your request will be checked and discussed. * __Create a single branch for that pull request__ -* If you want to be part of PocketMine-MP, we will ask you to. * Code using the syntax as in PocketMine-MP. See below for an example. * The code must be clear and written in English, comments included. +**Thanks for contributing to PocketMine-MP!** -__Thanks for contributing to PocketMine-MP!__ - - - -### Code syntax +### Code Syntax It is mainly [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md) with a few exceptions. * Opening braces MUST go on the same line. @@ -71,7 +68,7 @@ class ExampleClass{ } ``` -## Bug Tracking +## Bug Tracking for Collaborators ### Labels To provide a concise bug tracking environment, prevent the issue tracker from over flowing and to keep support requests out of the bug tracker, PocketMine-MP uses a label scheme a bit different from the default GitHub Issues labels. @@ -101,11 +98,9 @@ Miscellaneous labels are labels that show status not related to debugging that b - Mojang - This label is applied when the issue is suspected of being caused by the Minecraft: Pocket Edition client, but has not been confirmed. ### Closing Issues -To keep the bug tracker clear of non-related issues and to prevent it from overflowing, issues must be closed as soon as possible. +To keep the bug tracker clear of non-related issues and to prevent it from overflowing, **issues must be closed as soon as possible** (This may sound unethical, but it is MUCH better than having the BUG TRACKER filled with SUPPORT REQUESTS and "I NEED HELP"). - - **Support requests are not bugs.** Issues such as "How do I do this" are not bugs and are closed as soon as a collaborator spots it. They are referred to our Forum to seek assistance. - - ** No generic titles** such as "Question", "Help", "Crash Report" etc. If an issue has a generic title they will either be closed on the spot, or a collaborator will edit it to describe the actual symptom. - - Similarly, no generic issue reports. It is the issue submitter's responsibility to provide us an issue that is **trackable, debuggable, reproducible, reported professionally and is an actual bug**. If you do not provide us with a summary or instructions on how to reproduce the issue, it is a support request until the actual bug has been found and therefore the issue is closed. +If an issue does not conform to the "Creating an Issue" guidelines above, the issue should be closed. ### Milestones PocketMine-MP uses GitHub Milestones to set a goal for a new release. A milestone is set on the following occasions.