Skip to content

Coding Workflow

1. Pick an Issue

All development tasks are tracked in the GitLab Issue Board.

  1. Open the issue board.
  2. Pick an issue that is not assigned (or already assigned to you).
  3. Move the issue to In Progress.
  4. Assign yourself to the issue.

If you are new to the project, prefer issues labeled good-first-issue.

2. Create a Branch

Create a new branch for your work.

Branch names should be descriptive.

Examples:

feature/team-top-list\ fix/plot-reset-bug\ improvement-job-xp-calculation

3. Implement the Feature

While working on the issue:

  • follow the [[Coding Guidelines|Development/Coding-Guidelines]]
  • keep commits small and meaningful
  • test your changes on the [[Dev Server|Development/Dev-Server]]

4. Commit Your Changes

Use clear commit messages.

Example:

Fix plot reset duplication bug\ Add new special item 'infinite waterbucket'\ Improve job reward calculation

Avoid commits like:

fix\ update\ test

5. Create a Merge Request

Once the feature is finished:

  1. Push your branch
  2. Open a Merge Request
  3. Link the corresponding Issue
  4. Mark the issue with needs-review

6. Code Review

The code will be reviewed before merging.

During review:

  • changes may be requested
  • small improvements may be suggested

After approval, the merge request will be merged into main.

7. Deployment

After the merge, the plugin can be deployed to the [[Dev Server|Development/Dev-Server]] for further testing.