Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-eder committed Apr 22, 2021
0 parents commit e1eecef
Show file tree
Hide file tree
Showing 13 changed files with 656 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: "\U0001F6A8 Bug"
about: Did you come across a bug or unexpected behaviour differing from the docs?
labels: bug
---

<!--
Thanks for reporting a bug!
Before opening a new issue, please make sure that we do not have any duplicates already open.
You can ensure this by searching the issue list for this repository.
If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

## Describe the bug

<!-- Describe your issue, but please be descriptive! Thanks again -->

## Expected behaviour

<!-- A clear and concise description of what you expected to happen. -->

## Steps to reproduce the issue

<!-- include screenshots, logs, code or other info to help explain your problem -->

<!--
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-->

## Technical details

- Host Machine OS (Windows/Linux/Mac):

## Possible Fix

<!-- Not obligatory, but suggest a fix or reason for the bug -->

## Additional context

<!-- Add any other context about the problem here. -->
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/02_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: "\U0001F381 Feature Request"
about: Do you have an idea for a new feature?
labels: feature request
---

<!--
Thanks for requesting a feature!
Before opening a new issue, please make sure that we do not have any duplicates already open.
You can ensure this by searching the issue list for this repository.
If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

## Feature description

<!--
Provide a detailed description of the feature or improvement you are proposing.
What specific solution would you like? What is the expected behaviour?
Add any other context, screenshots, or code snippets about the feature request here as well.
-->

## Problem and motivation

<!--
Why is this change important to you? What is the problem this feature would solve?
How would you use it? How can it benefit other users?
-->

## Is this something you're interested in working on

<!-- Yes or No -->
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/03_enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "\u23F1\uFE0F Enhancement"
about: Do you have an idea for an enhancement?
labels: enhancement
---

<!--
Thanks for proposing an enhancement!
Before opening a new issue, please make sure that we do not have any duplicates already open.
You can ensure this by searching the issue list for this repository.
If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

## Current Implementation

<!-- Describe or point to the current implementation that you would like to see improved -->

## Suggested Enhancement

<!--
Outline the idea of your enhancement, by e.g., describing the algorithm you propose.
You can also create a Pull Request to outline your idea
-->

## Expected Benefits

<!--
Summarize how your enhancement could aid the implementation (performance, readability, memory consumption, battery consumption, etc.).
Please also back up with measurements or give detailed explanations for reduced runtime, memory consumption, etc.
-->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/04_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "\U00002753 Question"
about: If you have questions about pieces of the code or documentation for this component, please post them here.
labels: question
---

<!--
Thanks for submitting your question!
Before opening a new issue, please make sure that we do not have any duplicates already open.
You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
Also, please, have a look at our FAQs and existing questions before opening a new question.
-->

## Your Question

<!-- Include details about your question. -->

* Source File:
* Line(s):
* Question:
8 changes: 8 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# This file provides an overview of code owners in this repository.

# Each line is a file pattern followed by one or more owners.
# The last matching pattern has the most precedence.
# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.

# These are the default owners for the whole content of this repository. The default owners are automatically added as reviewers when you open a pull request, unless different owners are specified in the file.
* @ascheibal
130 changes: 130 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[opensource@telekom.de](mailto:opensource@telekom.de).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contributing

## Code of conduct

All members of the project community must abide by the [Contributor Covenant, version 2.0](CODE_OF_CONDUCT.md).
Only by respecting each other can we develop a productive, collaborative community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [opensource@telekom.de](mailto:opensource@telekom.de) and/or a project maintainer.

We appreciate your courtesy of avoiding political questions here. Issues which are not related to the project itself will be closed by our community managers.

## Engaging in our project

We use GitHub to manage reviews of pull requests.

* If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute)

* If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with `@...`) a suitable maintainer of this repository (see [CODEOWNERS](CODEOWNERS) of the repository you want to contribute to) in the description of the pull request.

* If you plan to do something more involved, please reach out to us and send an [email](mailto:opensource@telekom.de). This will avoid unnecessary work and surely give you and us a good deal of inspiration.

* Relevant coding style guidelines are available in the respective sub-repositories as they are programming language-dependent.

## Steps to Contribute

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue.

If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.

We kindly ask you to follow the [Pull Request Checklist](#Pull-Request-Checklist) to ensure reviews can happen accordingly.

## Contributing Code

You are welcome to contribute code in order to fix a bug or to implement a new feature.

The following rule governs code contributions:

* Contributions must be licensed under the [Apache 2.0 License](./LICENSE)
* Newly created files must be opened by an instantiated version of the file 'templates/file-header.txt'
* At least if you add a new file to the repository, add your name into the contributor section of the file NOTICE (please respect the preset entry structure)

## Contributing Documentation

You are welcome to contribute documentation to the project.

The following rule governs documentation contributions:

* Contributions must be licensed under the same license as code, the [Apache 2.0 License](./LICENSE)

## Pull Request Checklist

* Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.

* Commits should be as small as possible while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

* Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests. If tested manually, provide information about the test scope in the PR description (e.g. “Test passed: Upgrade version from 0.42 to 0.42.23.”).

* Create _Work In Progress [WIP]_ pull requests only if you need clarification or an explicit review before you can continue your work item.

* If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review by contacting us via [email](mailto:opensource@telekom.de).

* Post review:
* If a review requires you to change your commit(s), please test the changes again.
* Amend the affected commit(s) and force push onto your branch.
* Set respective comments in your GitHub review to resolved.
* Create a general PR comment to notify the reviewers that your amendments are ready for another round of review.

## Issues and Planning

* We use GitHub issues to track bugs and enhancement requests.

* Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee. Therefore, contributors may use but aren't restricted to the issue template provided by the project maintainers.

* When creating an issue, try using one of our issue templates which already contain some guidelines on which content is expected to process the issue most efficiently. If no template applies, you can of course also create an issue from scratch.

* Please apply one or more applicable [labels](/../../labels) to your issue so that all community members are able to cluster the issues better.
Loading

0 comments on commit e1eecef

Please sign in to comment.