Skip to content

Contributing

James edited this page Oct 25, 2022 · 5 revisions

Mundus Contribution Guide

What to work on?

Check out the Issues page for current bugs and feature requests. Issues suitable for first time contributors are normally tagged "Good First Issue". You can also see current milestones for next release to determine what issues are the highest priority.

Getting started

  1. Fork Mundus on https://github.com/JamesTKhan/Mundus
  2. Clone your fork
  3. Make changes to your fork
  4. Push changes & open a new pull request

Working from source

You can find more information about working with the sources in the wiki.

Code Style

Please use this eclipse formatter before you commit your changes.

If you create a new file, make sure to add the Apache file header.

If you create a new class or extend a existing one, make sure to add some documentation if your changes are not self explanatory. Changes or additions that are visible or have a great effect in the editor must be added to the changelog (editor/CHANGES).