Skip to content
This repository has been archived by the owner on Oct 28, 2023. It is now read-only.

Latest commit

 

History

History
executable file
·
158 lines (126 loc) · 10.1 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
158 lines (126 loc) · 10.1 KB
Raw

PocketMine-MP Contribution Guidelines

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 #pmmp or #pocketmine IRC channel on Freenode. There is a WebIRC if you do not want to install an IRC client.
  • You can ask directly to @PocketMine in Twitter, but don't expect an immediate reply.
  • You may use our Forum to ask questions.
  • We do not accept questions or support requests in our issue tracker.

Creating an Issue

  • First, use the Issue Search to check if anyone has reported it. Check also closed issues, as an issue you think is valid may actually be invalid.
    • If an issue has been fixed and closed, create another issue.
  • If your issue is related to a plugin, do not report here. Contact the plugin's original author instead.
  • 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. Please refer to the section I have a quesetion instead.
  • No generic titles such as "Question", "Help", "Crash Report" etc.
    • If you just got a crash report but you don't understand it, please look for a line starting with Message. It summarizes the bug.
  • Information must be provided in the issue body, not in the title. No tags like [BUG] are allowed in the title, including [SOLVED] for solved issues.
  • Similarly, no generic issue reports. For bugs, it is the issue author'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.
    • In simple words, if your issue does not appear to be a bug or a feature request, or if the issue cannot be properly confirmed to be valid, the issue will be closed until further information is provided.
  • To express appreciation, objection, confusion or other supported reactions on pull requests, issues or comments on them, use GitHub reactions rather than posting an individual comment with an emoji only. This helps keeping the issue/pull rqeuest conversation clean and readable.
  • If your issue is related to the Pocketmine-MP website, forums, etc., please talk to a human directly.

Contributing Code

  • Use the Pull Request system, your request will be checked and discussed.
  • Create each pull request on a new branch. Do not create a pull request on commits that exist in another pull request.
  • Code should use the same syntax as in PocketMine-MP. See below for an example.
  • The code must be clear and written in English, comments included.
  • Use descriptive commit titles
  • Keep each pull request only contain one feature. The only exception is when all features in the pull request are related to each other, and share the same core changes.
  • Do not create pull requests that only bump the MCPE version. If it is ready to be updated, the team will update the values directly. Do not change the MCPE version or protocol version in a pull request, unless you have updated the protocol (all packets) entirely.

Thanks for contributing to PocketMine-MP!

Code Syntax

It is mainly PSR-2 with a few exceptions.

  • Opening braces MUST go on the same line, and MUST NOT have spaces before.
  • else if MUST be written as elseif. (It is in PSR-2, but using a SHOULD)
  • Control structure keywords or opening braces MUST NOT have one space before or after them.
  • Code MUST use tabs for indenting.
  • Long arrays MAY be split across multiple lines, where each subsequent line is indented once.
  • Files MUST use only the <?php tag.
  • Files MUST NOT have an ending ?> tag.
  • Code MUST use namespaces.
  • Strings SHOULD use the double quote " except when the single quote is required.
<?php 

namespace pocketmine\example;

class ExampleClass{
	const EXAMPLE_CLASS_CONSTANT = 1;
	public $examplePublicVariable = "defaultValue";
	private $examplePrivateVariable;
	
	/**
	 * Creates an instance of ExampleClass
	 * @param string      $firstArgument  the first argument
	 * @param string|null $secondArgument default null
	 */
	public function __construct($firstArgument, &$secondArgument = null){
		if($firstArgument === "exampleValue"){ //Remember to use === instead == when possible
			//do things
		}elseif($firstArgument === "otherValue"){
			$secondArgument = function(){
				$this->examplePrivateVariable = [
					0 => "value1",
					1 => "value2",
					2 => "value3",
					3 => "value4",
					4 => "value5",
					5 => "value6",
				];
			};
		}
	}

}

RFC and Voting

  • These are big Pull Requests or contributions that change important behavior.
  • RFCs will be tagged with the PR: RFC label
  • A vote will be held once the RFC is ready. All users can vote commenting on the Pull Request
  • Comments MUST use "Yes" or "No" on the FIRST sentence to signify the vote, except when they don't want it to be counted.
  • If your comment is a voting comment, specify the reason of your vote or it won't be counted.
  • After voting has been closed, no further votes will be counted.
  • An RFC will be rejected if less than 50% + 1 (simple majority) has voted Yes.
  • If the RFC is approved, Team Members have the final word on its implementation or rejection.
  • RFCs with complex voting options will specify the vote percentage or other details.

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.

PocketMine-MP uses Labels to identify the types and status of issues and pull requests.

Categories

Category labels are prefixed by Related:. Multiple category labels may be applied to a single issue(but try to keep this to a minimum and do not overuse category labels).

  • Related: Core - This label is applied when the bug results in a fatal crash, or is related to neither Gameplay nor Plugin API.
  • Related: Gameplay - This label is applied when the bug effects the gameplay.
  • Related: Plugin 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: Addition - This label is applied when the Pull Request contributes new features or improvements, but does not fix a bug, nor controversial enough to be an RFC.
  • PR: RFC - Request for Comments. Refer to RFC and Voting.

Status

Status labels show the status of the issue. Multiple status labels may be applied.

  • Status: 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.
  • Status: Debugged - This label is applied when the cause of the bug has been found.
  • Status: High Priority - This label is applied when the bug is easy to fix, or if the scale of the bug is global.
  • Status: Insufficiently tested - This label is applied for pull requests that have not undergone tests strict enough.

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.

  • Affiliation: Mojang - This label is applied when the issue is suspected of being caused by the Minecraft client, but has not been confirmed.
  • Affiliation: MCPE - Same as Affiliated: Mojang, but only applied if the issue is only specific to the Pocket Edition (but not the Windows 10 Edition)
  • Affiliation: Windows 10 - Same as Affiliated: Mojang, but only applied if the issue is only specific to the Windows 10 Edition (but not the Pocket Edition)
  • Affiliation: Meta - This label is applied for issues or pull requests that are related to this GitHub repo. Still, do not report bugs related to other parts of PocketMine-MP.
  • Category: Bug - This label is applied to issues that are bugs, but not necessarily reproduced.
  • Category: 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.
  • Category: Protocol update - This label is applied if the issue or pull request is related to client protocol updates.
  • Category: 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.
  • Category: 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.

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").

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.

  • A new Beta release
  • A new Stable release

A milestone must use the following format:

Alpha_<version_number> [release_title][release_version]

For example:

Alpha_1.4 beta2