Link Search Menu Expand Document

Contribute

Everybody is welcome to contribute to MELT. There are 3 options to help the project:

  1. Spread the Word
  2. Improve the Documentation
  3. Improve and Extend the Code Base

Spread the Word

If you are using MELT, reference and recommend the framework to peers. In case you experience any (potential) bugs, open an issue on GitHub.

For specific questions, feel free to contact the authors of the main paper (or the paper addressing the component you have a question about).

Improve the Documentation

You do not have to be a programmer to help MELT. You can easily help us by improving the documentation (this user guide). The contents of the guide are managed through GitHub; just go to the MELT gh-pages branch. There, you will find a markdown file for every page in this user guide. The markdown file for this page, for instance can be found here: https://github.com/dwslab/melt/blob/gh-pages/8_contribute/0_contribute.md

You can easily change files directly in your Web browser by clicking on the edit pencil as shown in the following screen shot:

image

Note that when you commit a documentation change, you have to set the pull request for branch gh-pages (not master):

image

Alternatively to changes in the Web UI, you can also fork the project (remember to git checkout gh-pages), apply your changes locally, and perform a pull request.

After you applied your changes and they have been confirmed by the administrators, the new page will be automatically built by our pipeline and will immediately appear in the rendered user guide.

Improve and Extend the Code Base

If you are knowlegeable in Java and/or Python and you want to add features to MELT or fix bugs: Simply fork the repository and create a pull request. We are happy to merge any improvements in the main branch.

MELT code quality is ensured by more than 200 unit tests. You can check that you did not accidently break anything with your changes by running them. Ideally, you also create a unit test for your new feature / your fix to ensure that it works as intended.


Table of contents