Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.02 KB

Contributing to MiSim

Hello there, thank you for having an interest into MiSim! We appreciate any contribution. If you'd like to help, but don't know where to start, you can check out the issues page. If you have any questions or suggestion, feel free to create an issue or contact an author directly.

If you would like to contribute to MiSim, please follow the guidelines below.

  1. Fork the repository
  2. Create a new branch and make your changes in it
  3. Create a pull request to the develop branch
  4. Wait for the review/approval.

Your code will be automatically checked using the checkstyle configuration found in checkstyle.xml and using unit tests. Please make sure that your code is formatted correctly and that all tests pass (e.g. by using a checkstyle plugin). Further, we appreciate if you would add further unit tests for your code.

In case you need access to the underlying simulation engine, check out the DESMOJ-SOURCE branch.

Check out the wiki for usage instructions.

Good Luck! 😄