How to contribute#
Thank you for your interest in becoming a part of natESM 🙌! We greatly appreciate your willingness to contribute. We welcome contributions of any kind, whether they involve providing notes about errors, improving descriptions, posing questions, or offering detailed information about optional components, and more.
This document is designed to provide guidance on how we organize contributions.
First steps#
Editing the natESM system and its components requires an active DKRZ-GitLab account. To obtain a user account, please visit the following page if you don’t already have access to DKRZ systems: Getting a user account.
User settings: You can adjust all your personal account settings within the luv.dkrz.de system.
User Support: If you require assistance beyond the registration process for the natESM system, our Support Team can be contacted via email at info@nat-esm.de or by phone +49 40 460094 283.
Getting involved: Quick start 🚀
General remarks: For each topic, there is a designated contact person from the natESM steering committee. If you encounter significant changes or encounter issues related to a particular topic, please reach out to the respective contact person for assistance. For general guidance on using and editing the natESM system, don’t hesitate to contact the support team at info@nat-esm.de.
Editing an existing issue: ✏️
Begin by cloning the repository.
Make your desired changes. Please ensure that you add or modify information regarding a (sub)component, model, or code version within the existing categories.
Submit these changes via a “Commit”, which will lead to a pipline in a new branch running. If this pipeline suceeded 🤞🏼, you can see your changes on the local Gitlab. After,a new “Merge request” is generated - and will be implemented by the maintainers.
If you require further assistance on how to clone and edit a repository, feel free to contact the support team.
Adding a missing issue: 📖 If you wish to introduce a new sub-category or sub-model, start by using the word.docx that includes the existing categories. Next, get in touch with the contact person responsible for the relevant topic. Following their approval, the contact person will incorporate the new module, subject to consultation with the steering committee overseeing the model system.
Adding some new ideas/plans/thoughts or problems: 💡 If you have an interesting idea, problem or want to exchange thoughts with others, start a new issue 💬. Please have a look at exististing issues, where you maybe can find similar input.
Collaborating and working with your team: 🤝 Extend invitations to team members from your respective institutes and collaborators involved in the natESM project to participate in the ongoing development of the natESM system.
Reviewing and commenting#
To comment a page, model or component you can open a new issue 💬. You can check than on the overview page, if there is already an open comment on your issue. It would be good to look here first and add your comment or reaction to an existing issue if there is one. If you have edited a file and submit your changes a Merge request will be generated, which could be reviewed and commented as well. Please check that your changes correspond to the description. If new issues arises, please open a new Merge reuest 🆕 and reference it back to the original.
Hints and links#
natESM system uses markdown as language for text articels. For making it even more easier we use an extension MyST. Please have a closer look at the Markdown documentation for a general introduction in md-files and the MyST homepage for syntax and typography examples (e.g. tables, images, admonitions, code snippets and live editor).