Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (45 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 2 KB

Contributing

Thank You

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

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>/Currencies.git
  4. Open the project in your IDE.
  5. Build the plugin: ./gradlew build 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.

Language Files

For any user-facing string changes, update the appropriate resource files under src/main/resources/ (for example, plugin.yml or config.yml). If you add a new localization or language file structure, document it in your pull request.

Testing

Run the unit tests with:

Linux: ./gradlew clean test Windows: .\gradlew.bat clean test

For manual testing, start a local Spigot server using the helper script:

./up.sh

To stop the local Spigot server when you're done testing:

./down.sh

Questions

Ask in the Discord server.