59 lines (39 loc) · 1.63 KB

Contributing

Thank You

Thank you for your interest in contributing to Bluemap_MedievalFactions! 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

Sign up for GitHub if you don't have an account.
Fork the repository by clicking Fork at the top right of the repo page.
Clone your fork: git clone https://github.com/<your-username>/Bluemap_MedievalFactions.git
Open the project in your IDE.
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

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

Testing

Run the unit tests with:

Linux: mvn clean test Windows: mvn.cmd clean test

Questions

Ask in the Discord server.