Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (40 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.74 KB
Raw

Contributing

Thank You

Thank you for your interest in contributing to Democracy! 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
  • Medieval Factions (required dependency)

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>/Democracy.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 main: git checkout main
  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 main, link the related issue with #<number>.
  9. Address review feedback.

Testing

Run the build with:

mvn clean package

For manual testing, place the JAR and the Medieval Factions JAR into a local Spigot server's plugins/ folder and restart.

Questions

Ask in the Discord server.