CONTRIBUTING.md

Contributing

Thank You

Thank you for your interest in contributing to Dans-Spawn-System! This guide will help you get started.

Links

• Website
• Discord

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-Spawn-System.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 for this project.

Please verify your changes manually by:

• Building the plugin: mvn clean package
• Copying the built JAR from target/ into your test server's plugins/ folder
• Starting the server and ensuring the plugin loads without errors in the console
• Exercising relevant spawn-related functionality to confirm your changes behave as expected

Questions

Ask in the Discord server.