Skip to content
This repository has been archived by the owner on Nov 25, 2022. It is now read-only.

Contributor's guide

Cole Bryant edited this page Jan 30, 2020 · 14 revisions

General guidelines

Before we get started, here are a few general rules to keep in mind when contributing.

  • Read the docs, especially those for Discord4J (and other libraries, if you come into contact with them).
  • Don't cause errors. If your code is unfinished or causes a build failure, it shouldn't be committed. Keeping unfinished or buggy changes local after a programming session is fine and part of the Git workflow.
  • Avoid causing warnings.
  • Follow existing conventions to the best of your ability/understanding.
  • Keep your commit messages concise, but detailed.

Code style

ghost2, for the most part, follows Google's Java Style Guide. In cases where you're not sure how to format your code, refer to existing project code, then the style guide.

Sections

Clone this wiki locally