From d743888b8d4e53466ed38949e671c74e72242d17 Mon Sep 17 00:00:00 2001 From: Michael Yoo Date: Mon, 14 Jul 2014 17:11:25 +0930 Subject: [PATCH 1/3] Issue Tracking Guidelines --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e560f707..5388063cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,3 +71,53 @@ class ExampleClass{ } ``` +## Bug Tracking + +### 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. + +PocketMine-MP uses GitHub Issues Labels. There are a total of ten(10) labels. + +#### Categories +Category labels are prefixed by `C:`. Multiple category labels may be applied to a single issue(but try to keep this to a minimum and do not overuse category labels). + - C: Core - This label is applied when the bug results in a fatal crash, or is related to neither Gameplay nor Plugin API. + - C: Gameplay - This label is applied when the bug effects the gameplay. + - C: API - This label is applied when the bug effects the Plugin API. + +#### Pull Requests +Pull Requests are prefixed by `PR:`. Only one label may be applied for a Pull Request. + - PR: Bug Fix - This label is applied when the Pull Request fixes a bug. + - PR: RFC (Request For Comments) - This label is applied when the Pull Request suggests an improvement. + +#### Status +Status labels show the status of the issue. Multiple status labels may be applied. + - Reproduced - This label is applied when the bug has been reproduced, or multiple people are reporting the same issue and symptoms in which case it is automatically assumed that the bug has been reproduced in different environments. + - Debugged - This label is applied when the cause of the bug has been found. + - Priority - This label is applied when the bug is easy to fix, or if the scale of the bug is global. + +#### Miscellaneous +Miscellaneous labels are labels that show status not related to debugging that bug. The To-Do label and the Mojang label may not be applied to a single issue at the same time. + - To-Do - This label is applied when the issue is not a bug, but a feature request or a list of features to be implemented that count towards a milestone. + - 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. + + - **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. + +### Milestones +PocketMine-MP uses GitHub Milestones to set a goal for a new release. A milestone is set on the following occasions. + + - A new Beta release + - A new Stable release + +A milestone must use the following format: +``` +Alpha +``` +For example: +``` +Alpha 1.4 Beta 2 +``` \ No newline at end of file From dbe5e9b4e9cc7b52ff2b65715f993069b8837dc7 Mon Sep 17 00:00:00 2001 From: Michael Yoo Date: Mon, 14 Jul 2014 17:25:28 +0930 Subject: [PATCH 2/3] 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. From 7812a3c4fc9fc36ae0f44d2075283a37e85453f6 Mon Sep 17 00:00:00 2001 From: Michael Yoo Date: Mon, 14 Jul 2014 20:15:26 +0930 Subject: [PATCH 3/3] Added Won't Fix and Invalid as per @shoghicp's suggestion. Renamed PR: RFC to PR: Contribution --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44b79396d..bd7a37056 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,7 +73,9 @@ class ExampleClass{ ### 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. -PocketMine-MP uses GitHub Issues Labels. There are a total of ten(10) labels. +PocketMine-MP uses GitHub Issues Labels. There are a total of 12 labels. + +Note: For future reference, labels must not be longer than 15 letters. #### Categories Category labels are prefixed by `C:`. Multiple category labels may be applied to a single issue(but try to keep this to a minimum and do not overuse category labels). @@ -84,18 +86,20 @@ Category labels are prefixed by `C:`. Multiple category labels may be applied to #### Pull Requests Pull Requests are prefixed by `PR:`. Only one label may be applied for a Pull Request. - PR: Bug Fix - This label is applied when the Pull Request fixes a bug. - - PR: RFC (Request For Comments) - This label is applied when the Pull Request suggests an improvement. + - PR: Contribution - This label is applied when the Pull Request contributes code to PocketMine-MP such as a new feature or an improvement. #### Status Status labels show the status of the issue. Multiple status labels may be applied. - Reproduced - This label is applied when the bug has been reproduced, or multiple people are reporting the same issue and symptoms in which case it is automatically assumed that the bug has been reproduced in different environments. - Debugged - This label is applied when the cause of the bug has been found. - Priority - This label is applied when the bug is easy to fix, or if the scale of the bug is global. + - Won't Fix - This label is applied if the bug has been decided not be fixed for some reason. e.g. when the bug benefits gameplay. *This label may only be applied to a closed issue.* #### Miscellaneous Miscellaneous labels are labels that show status not related to debugging that bug. The To-Do label and the Mojang label may not be applied to a single issue at the same time. - To-Do - This label is applied when the issue is not a bug, but a feature request or a list of features to be implemented that count towards a milestone. - Mojang - This label is applied when the issue is suspected of being caused by the Minecraft: Pocket Edition client, but has not been confirmed. + - Invalid - This label is applied when the issue is reporting a false bug that works as intended, a support request, etc. *This label may only be applied to a closed issue.* ### 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** (This may sound unethical, but it is MUCH better than having the BUG TRACKER filled with SUPPORT REQUESTS and "I NEED HELP").