Skip to content
Snippets Groups Projects
howto_contribute.md 1.59 KiB
Newer Older
Ulf Markwardt's avatar
Ulf Markwardt committed
# How To Contribute
## Contribute via Issue
Users can contribute to the documentation via the
[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues).
For that, open an issue to report typos and missing documentation or request for more precise
wording etc.  ZIH staff will get in touch with you to resolve the issue and improve the
documentation.
**Reminder:** Non-documentation issues and requests need to be send as ticket to
[hpcsupport@zih.tu-dresden.de](mailto:hpcsupport@zih.tu-dresden.de).
## Contribute via Web IDE
Ulf Markwardt's avatar
Ulf Markwardt committed

GitLab offers a rich and versatile web interface to work with repositories. To fix typos and edit
source files, just select the file of interest and click the `Edit` button. A text and commit
editor are invoked: Do your changes, add a meaningful commit message and commit the changes.
Ulf Markwardt's avatar
Ulf Markwardt committed

The more sophisticated integrated Web IDE is reached from the top level menu of the repository or
by selecting any source file.
Ulf Markwardt's avatar
Ulf Markwardt committed

Other git services might have an equivalent web interface to interact with the repository. Please
refer to the corresponding documentation for further information.
Ulf Markwardt's avatar
Ulf Markwardt committed

<!--This option of contributing is only available for users of-->
<!--[gitlab.hrz.tu-chemnitz.de](https://gitlab.hrz.tu-chemnitz.de). Furthermore, -->
Ulf Markwardt's avatar
Ulf Markwardt committed

## Contribute Using Git Locally
Ulf Markwardt's avatar
Ulf Markwardt committed

For experienced Git users, we provide a Docker containier that includes all checks of the CI engine
used in the backend. Using them should ensure that mareg requests will not be blocked
Ulf Markwardt's avatar
Ulf Markwardt committed
due to automatic checking.
For details, see [Work Locally Using Containers](contribute_container.md).