[WIP] Add docs for contributing to Nucleus development #14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dualspiral
reviewed
Jun 14, 2017
| A simple module is a module which does not have any configuration whatsoever. You can add commands, listeners, and tasks to a module. In | ||
| order to begin creating a module you must first locate the src/main/java/io/github/nucleuspowered/nucleus/modules package. Next a new | ||
| package must be created which will contain the new module. To finish with creating a very basic module all that needs doing is creating a | ||
| new class in the package and adding the @ModuleData annotation including a String id and name for the module. |
There was a problem hiding this comment.
Any annotations or paths should be enclosed in backticks, so @ModuleData
dualspiral
reviewed
Jun 14, 2017
|
|
||
| ## Explanation | ||
| A simple module is a module which does not have any configuration whatsoever. You can add commands, listeners, and tasks to a module. In | ||
| order to begin creating a module you must first locate the src/main/java/io/github/nucleuspowered/nucleus/modules package. Next a new |
There was a problem hiding this comment.
The package is io.github.nucleuspowered.nucleus.modules. The path in the repo is this.
dualspiral
reviewed
Jun 14, 2017
| ## Explanation | ||
| A simple module is a module which does not have any configuration whatsoever. You can add commands, listeners, and tasks to a module. In | ||
| order to begin creating a module you must first locate the src/main/java/io/github/nucleuspowered/nucleus/modules package. Next a new | ||
| package must be created which will contain the new module. To finish with creating a very basic module all that needs doing is creating a |
There was a problem hiding this comment.
The package should be named the same, or similar, to the proposed module ID.
There was a problem hiding this comment.
Also, might be worth mentioning that the plugin variable is automatically available for use.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is to help future developers in contributing to Nucleus. Right now I'd like feedback on formatting and whether or not it's detailed enough. Something that seems very obvious to me may not be to someone else. This is a WIP and I'm going to be adding more pages in the coming days.