Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (46 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 2.11 KB

Contributing

Thank You

Thank you for your interest in contributing to Dan's Essentials! This guide will help you get started.

Links

Requirements

  • A GitHub account
  • Git installed on your local machine
  • A Java IDE or text editor
  • A basic understanding of Java

Getting Started

  1. Sign up for GitHub if you don't have an account.
  2. Fork the repository by clicking Fork at the top right of the repo page.
  3. Clone your fork: git clone https://github.com/<your-username>/Dans-Essentials.git
  4. Open the project in your IDE.
  5. Build the plugin: mvn clean package If you encounter errors, please open an issue.

Identifying What to Work On

Issues

Work items are tracked as GitHub issues.

Milestones

Issues are grouped into milestones representing upcoming releases.

Making Changes

  1. Make sure an issue exists for the work. If not, create one.
  2. Switch to develop: git checkout develop
  3. Create a branch: git checkout -b <branch-name>
  4. Make your changes.
  5. Test your changes.
  6. Commit: git commit -m "Description of changes"
  7. Push: git push origin <branch-name>
  8. Open a pull request against develop, link the related issue with #<number>.
  9. Address review feedback.

Testing

There are currently no automated unit tests configured in this project. To verify your changes compile correctly, run:

Linux: mvn clean package
Windows: mvn clean package

If you see BUILD SUCCESS, the plugin compiled successfully.

For manual testing, start a local Spigot or Paper server:

  1. Download a Spigot or Paper server JAR.
  2. Create a new folder and place the server JAR inside.
  3. Run java -jar <server-jar>.jar and follow the setup prompts.
  4. Copy the built plugin JAR from target/ into the server's plugins folder.
  5. Start or restart the server and verify your changes in-game.

Questions

Ask in the Discord server.