Skip to main content

Contributing

Prerequisites​

  • Java 25
  • Maven 3.9+
  • Node 18+ (for documentation site)

Build​

mvn clean package

Output: bootstrap/target/igniscore-1.0.0.jar

Run tests​

mvn test

Extension modules include MockBukkit strategy and behavior tests.

Documentation site​

cd website
npm install
npm start          # http://localhost:3000

Production build (includes Javadoc when run locally):

cd website
npm run build:javadoc   # optional locally; CI does this
npm run build

Adding a doc page​

  1. Create website/docs/{section}/{page-name}.md with frontmatter (title, description, slug)
  2. Add doc ID to website/sidebars.ts
  3. Optionally add to navbar in website/docusaurus.config.ts
  4. Cross-link from related pages
  5. Use 1.0.0 / rowan-smith/IgnisCore for versioned content
  6. Run npm run build — broken links fail the build

Pull requests​

  • Keep changes focused
  • Update docs when behavior or developer workflow changes
  • Ensure mvn test passes