Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.8 KB
Raw

Contributing to the MultiApps

Did you find a bug?

  • Check if the bug has already been reported and has an open Issue.

  • If there is none, create one by using the provided Issue Template for bugs.

  • Try to be as detailed as possible when describing the bug. Every bit of information helps!

Do you have a question or need support?

If you need any support or have any questions regarding the project, you can drop us a message on Slack or open an Issue and we shall get back to you.

Do you want to contribute to the code base?

Starter GitHub Issues

If you are looking for what you can contribute to the project, check the GitHub Issues labeled as Good First Issue to find items that are marked as more beginner friendly.

Fork the project

  • To develop your contribution to the project, first fork this repository in your own github account.

  • When developing make sure to keep your fork up to date with the origin's master branch or the release branch you want to contribute a fix to.

How to build and package?

Execute mvn clean install in the project's root folder.

Testing

  • To ensure no regressions to previous functionality execute mvn clean test in the project's root folder to run all the unit tests.

  • If you are developing new functionality make sure to add tests covering the new scenarios where applicable!

Formatting

Having the same style of formatting across the project helps a lot with readability.

Eclipse

Our team is developing on the Eclipse IDE and we have a handy formatter located at /ide/eclipse-formatter.xml. In Eclipse you can import the formatter from Window > Preferences > Java > Code Style > Formatter

IntelliJ

If you're using IntelliJ you can try the EclipseCodeFormatter plugin. Just follow the provided formatter manual using the ecplipse formatter file. Note: In the "Optimizing Imports" configuration use "Manual configuration" for the import order: java;javax;org;com;

NetBeans

NetBeans also provides such a plugin. Just search for eclipse formatter in the PluginPortal.

Creating a pull request

When creating a pull request please use the provided template. Don't forget to link the Issue if there is one related to your pull request!