mirror of https://github.com/PaperMC/Paper.git synced 2025-01-07 16:57:42 +01:00

History

Bukkit/Spigot 14c7734fb1 Add tab-completion API. Fixes BUKKIT-2181. Adds BUKKIT-2602 CommandMap contains a method that will auto-complete commands appropriately. Before the first space, it searches for commands of which the sender has permission. After the first space, it delegates to the individual command. Vanilla commands contain implementations to mimic vanilla implementation. Exception would be give, that allows for name matching; a feature we already allowed as part of the command is now supported for auto-complete as well. Plugin commands can get a tab completer set to delegate the completion for. If no tab completer is set, it can check the executor to see if it implements the tab completion interface. It will also attempt to chain calls if null gets returned from these interfaces. Plugins also implement the new TabCompleter interface, to add ease-of-use for plugin developers, similar to the onCommand() method. The default command implementation simply searches for player names. To help facilitate command completion, a utility class was added with two functions. One checks two strings, to see if the specified string starts with (ignoring case) the second. The other method uses the first to selectively copy elements from one collection to another. By: Score_Under <seejay.11@gmail.com>		2012-10-09 14:54:12 -05:00
..
src	Add tab-completion API. Fixes BUKKIT-2181. Adds BUKKIT-2602	2012-10-09 14:54:12 -05:00
.gitignore	IntelliJ is awesome.	2011-07-05 00:14:31 -04:00
LICENCE.txt	We're GPL.	2011-01-02 10:57:42 +01:00
pom.xml	Updated version to 1.3.2-R1.1-SNAPSHOT for development towards next release.	2012-09-28 16:33:59 -04:00
README.md	Updated README.md with more coding and pull request conventions and tips to get your pull request accepted.	2012-02-24 00:08:31 -05:00

README.md

Bukkit

A Minecraft Server API.

Website: http://bukkit.org
Bugs/Suggestions: http://leaky.bukkit.org

Compilation

We use maven to handle our dependencies.

Install Maven 3
Check out this repo and: mvn clean install

Coding and Pull Request Conventions

We generally follow the Sun/Oracle coding standards.
No tabs; use 4 spaces instead.
No trailing whitespaces.
No CRLF line endings, LF only, put your gits 'core.autocrlf' on 'true'.
No 80 column limit or 'weird' midstatement newlines.
The number of commits in a pull request should be kept to a minimum (squish them into one most of the time - use common sense!).
No merges should be included in pull requests unless the pull request's purpose is a merge.
Pull requests should be tested (does it compile? AND does it work?) before submission.
Any major additions should have documentation ready and provided if applicable (this is usually the case).
Most pull requests should be accompanied by a corresponding Leaky ticket so we can associate commits with Leaky issues (this is primarily for changelog generation on dl.bukkit.org).
Try to follow test driven development where applicable.

Tips to get your pull request accepted

Making sure you follow the above conventions is important, but just the beginning. Follow these tips to better the chances of your pull request being accepted and pulled.

Make sure you follow all of our conventions to the letter.
Make sure your code compiles under Java 5.
Provide proper JavaDocs where appropriate.
Provide proper accompanying documentation where appropriate.
Test your code.
Make sure to follow coding best practises.
Provide a test plugin binary and source for us to test your code with.
Your pull request should link to accompanying pull requests.
The description of your pull request should provide detailed information on the pull along with justification of the changes where applicable.