Repository files navigation

ESID is a visualization of infectious disease propagation developed at theGerman Aerospace Center (DLR).It allows displaying historical data, as well as analyzing simulation results of pandemics.

• Features
• Developer Documentation
• Contributing to ESID
  • Branching Guidelines
  • Git Commit Messages
  • Forking ESID
• Contributor Covenant Code of Conduct
  • Our Pledge
  • Our Standards
  • Our Responsibilities
  • Scope
  • Enforcement
  • Attribution
• Current Contributors
  • Previous Contributors
• License

You can find a list of the latest changes in thechangelog.

You can find the developer documentation for the front- and backend in the corresponding folders:

• Backend Developer Documentation
• Frontend Developer Documentation

Whenever you encounter a 🪲bug or have 🎉feature request,report this viaGithub issues.

We are happy to receive contributions to ESID in the form ofpull requests via Github.Feel free to fork the repository, implement your changes and create a merge request to thedevelop branch.There is aforking guide available to get you started!

The development of ESID follows a simplified version ofgit-flow: Themain branch always contains stable code.New features and bug fixes are implemented infeature/* orfix/* branches and are merged todevelop once they are finished.When a new milestone is reached, the content ofdevelop will be merged tomain and a tag is created.

Github Actions are used for continuous integration.All pull requests and pushes tomain anddevelop are built automatically.

Commits should start with a Capital letter and should be written in present tense (e.g.🎉 Add cool new feature instead of🎉 Added cool new feature).It's a great idea to start the commit message with an applicable emoji. This does not only look great but also makes you rethink what to add to a commit.

• 🎉:tada: when adding a cool new feature
• 🔧:wrench: when refactoring / improving a small piece of code
• 🔨:hammer: when refactoring / improving large parts of the code
• ✨:sparkles: when formatting code
• 🎨:art: improving / adding assets like textures or images
• 🚀:rocket: when improving performance
• 📝:memo: when writing docs
• 🪲:beetle: when fixing a bug
• 💚:green_heart: when fixing the CI build
• ✔️:heavy_check_mark: when working on tests
• 🔼:arrow_up_small: when adding / upgrading dependencies
• 🔽:arrow_down_small: when removing / downgrading dependencies
• 🔀:twisted_rightwards_arrows: when merging branches
• 🔥:fire: when removing files
• 🚚:truck: when moving / renaming files or namespaces

A good way to enforce this on your side is to use acommit-hook. To do this, paste the following script into.git/hooks/commit-msg.

#!/bin/bash# regex to validate in commit msgcommit_regex='(:(tada|wrench|hammer|sparkles|art|rocket|memo|beetle|green_heart|arrow_up_small|arrow_down_small|twisted_rightwards_arrows|fire|truck|heavy_check_mark):(.+))'error_msg="Aborting commit. Your commit message is missing an emoji as described in the contributing guideline."if! grep -xqE"$commit_regex""$1";thenecho"$error_msg">&2exit 1fi

And make sure that it is executable:

chmod +x .git/hooks/commit-msg

This is pretty straight-forward. Just click theFork button on the top right of this page.Then clone the forked repository, perform your changes, push to a feature branch and create a pull request to ESID's develop branch.

git clone git@github.com:<your user name>/ESID.gitcd ESIDgit remote add upstream git@github.com:DLR-SC/ESID.gitgit checkout developgit checkout -b feature/your-new-feature# orgit checkout -b fix/your-bugfix# ... do and commit your changes!git push origin feature/your-new-feature

When there were changes in ESID's develop branch, you will need to merge those to your fork before creating a pull request:

git fetch upstreamgit merge upstream/develop

Then you can create a pull request on GitHub to ESID's develop branch.

In the interest of fostering an open and welcoming environment, we ascontributors and maintainers pledge to making participation in our project andour community a harassment-free experience for everyone, regardless of age, bodysize, disability, ethnicity, sex characteristics, gender identity and expression,level of experience, education, socio-economic status, nationality, personalappearance, race, religion, or sexual identity and orientation.

Examples of behavior that contributes to creating a positive environmentinclude:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Gracefully accepting constructive criticism
• Focusing on what is best for the community
• Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

• The use of sexualized language or imagery and unwelcome sexual attention oradvances
• Trolling, insulting/derogatory comments, and personal or political attacks
• Public or private harassment
• Publishing others' private information, such as a physical or electronicaddress, without explicit permission
• Other conduct which could reasonably be considered inappropriate in aprofessional setting

Project maintainers are responsible for clarifying the standards of acceptablebehavior and are expected to take appropriate and fair corrective action inresponse to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, orreject comments, commits, code, wiki edits, issues, and other contributionsthat are not aligned to this Code of Conduct, or to ban temporarily orpermanently any contributor for other behaviors that they deem inappropriate,threatening, offensive, or harmful.

This Code of Conduct applies both within project spaces and in public spaceswhen an individual is representing the project or its community. Examples ofrepresenting a project or community include using an official project e-mailaddress, posting via an official social media account, or acting as an appointedrepresentative at an online or offline event. Representation of a project may befurther defined and clarified by project maintainers.

Instances of abusive, harassing, or otherwise unacceptable behavior may bereported by contacting the project team atmartin.kuehn@dlr.de. Allcomplaints will be reviewed and investigated and will result in a response thatis deemed necessary and appropriate to the circumstances. The project team isobligated to maintain confidentiality with regard to the reporter of an incident.Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in goodfaith may face temporary or permanent repercussions as determined by othermembers of the project's leadership.

This Code of Conduct is adapted from theContributor Covenant, version 1.4,available athttps://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, seehttps://www.contributor-covenant.org/faq

German Aerospace Center (DLR):

• Martin Kühn
• Jonas Gilg
• Luca Spataro
• Moritz Zeumer
• Pawandeep Kaur-Betz

German Aerospace Center (DLR):

• Margrit Klitz
• Kerem Balci
• Selma Dahmani
• Laurin Kerkloh

Hochschule für Gestaltung Schwäbisch Gmünd (HfG):

• Julien Stoll
• Valerie Grappendorf

Copyright 2021-2023 German Aerospace Center (DLR)

Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.