Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
aessing committed Dec 27, 2020
0 parents commit e737508
Show file tree
Hide file tree
Showing 17 changed files with 617 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Explanation of this file
# https://help.github.com/articles/about-codeowners/

* @aessing

###############################################################################
# This is a comment.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
#* @global-owner1 @global-owner2

# Order is important; the last matching pattern takes the most
# precedence. When someone opens a pull request that only
# modifies JS files, only @js-owner and not the global
# owner(s) will be requested for a review.
#*.js @js-owner

# You can also use email addresses if you prefer. They'll be
# used to look up users just like we do for commit author
# emails.
#*.go docs@example.com

# In this example, @doctocat owns any files in the build/logs
# directory at the root of the repository and any of its
# subdirectories.
#/build/logs/ @doctocat

# The `docs/*` pattern will match files like
# `docs/getting-started.md` but not further nested files like
# `docs/build-app/troubleshooting.md`.
#docs/* docs@example.com

# In this example, @octocat owns any file in an apps directory
# anywhere in your repository.
#apps/ @octocat

# In this example, @doctocat owns any file in the `/docs`
# directory in the root of your repository.
#/docs/ @doctocat
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: aessing
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Bug report
about: Create a report to help to improve the project
title: ''
labels: 'bug'
assignees: ''
---

<!-- Please provide a general summary of the issue in the title above -->

## Description
<!-- Please provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->

## Expected Behavior
<!-- Please provide, what should happen -->

## Actual Behavior
<!-- Please provide, what happens instead -->

## Context
<!-- How has this bug affected you? What were you trying to accomplish? -->

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

## Steps to Reproduce
<!-- Please provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant -->
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Your Environment
<!-- Please include as many relevant details about the environment you experienced the bug in -->
- Version used:
- Environment name and version (e.g. Chrome 39, node.js 5.4):
- Operating System and version
- Desktop or mobile:
- Hardware used:
- etc.

## Screenshots
<!-- If applicable, please add screenshots to help explain your problem. -->

## Additional context
<!-- Please add any other context about the problem here. -->
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/critical_bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Critical bug report
about: Create a report for a critical issue
title: ''
labels: 'bug, critical'
assignees: ''
---

<!-- Please provide a general summary of the issue in the title above -->

## Description
<!-- Please provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->

## Expected Behavior
<!-- Please provide, what should happen -->

## Actual Behavior
<!-- Please provide, what happens instead -->

## Context
<!-- How has this bug affected you? What were you trying to accomplish? -->

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

## Steps to Reproduce
<!-- Please provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant -->
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Your Environment
<!-- Please include as many relevant details about the environment you experienced the bug in -->
- Version used:
- Environment name and version (e.g. Chrome 39, node.js 5.4):
- Operating System and version
- Desktop or mobile:
- Hardware used:
- etc.

## Screenshots
<!-- If applicable, please add screenshots to help explain your problem. -->

## Additional context
<!-- Please add any other context about the problem here. -->
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Documentation issue
about: Report issues in the documentation
title: ''
labels: 'documentation'
assignees: ''
---

<!-- Please provide a general summary of the issue in the title above -->

## URL to the Article
<!-- Please provide to the document that you report the issue for -->

## Description
<!-- Please provide a more detailed introduction to the issue itself, and why you consider it to be a documentation issue -->

## Expected Documentation
<!-- Please tell what you expected to find in the documentation -->

## Actual Documentation
<!-- Please tell what you found in the documentation -->

## Context
<!-- How has this issue affected you? What were you trying to accomplish? -->

## Possible Fix
<!-- Not obligatory, but suggest a fix or reason for the issue -->

## Screenshots
<!-- If applicable, please add screenshots to help explain your problem. -->

## Additional context
<!-- Please add any other context about the problem here. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'feature'
assignees: ''
---

<!-- Please provide a general summary of the feature request in the title above -->

## Detailed Description
<!-- Please provide a detailed description of the change or addition you are proposing -->

## Context
<!-- Why is this change important to you? How would you use it? How can it benefit other users? -->

## Possible Implementation
<!-- Not obligatory, but please suggest an idea for implementing addition or change -->

## Describe Alternatives
<!-- Please provide a clear and concise description of any alternative solutions or features you've considered. -->

## Additional context
<!-- Please add any other context or screenshots about the feature request here. -->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Question
about: You have a question about the project?
title: ''
labels: 'question'
assignees: ''
---

<!-- Please ask your question and provide as much detail as you can. So you help us to provide the best possible answer -->
60 changes: 60 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<!-- Please provide a general summary of your changes in the title above -->

# Pull Request
Thank you for your contribution.

Before submitting this Pull Request, please make sure: _Put an `x` in the boxes that apply_
- [ ] You reviewed our [guidelines for contributing](../CONTRIBUTING.md) to this repository
- [ ] Does an issue exists which is related to this Pull Request <!--- This project only accepts Pull Requests related to open issues -->
- [ ] Your code builds clean without any errors or warnings
- [ ] You are using approved terminology
- [ ] You have added necessary documentation (if appropriate)
- [ ] You have added unit tests

## Proposed changes
<!-- Please describe the big picture of your changes here to communicate to the maintainers why we should accept this Pull Request. Why is this change required? What problem does it solve? -->

## Types of changes
What types of changes does your change introduce? _Put an `x` in the boxes that apply_
- [ ] New feature (adds functionality) <!-- If suggesting a new feature or change, please discuss it in an issue first -->
- [ ] Bugfix (fixes an issue) <!-- If fixing a bug, there should be an issue describing it with steps to reproduce -->
- [ ] Security (fixes an security issue) | Please have a look at our [Security Policy](../SECURITY.md) first.
- [ ] Code style cleaning or Refactoring (formatting, renaming, restructuring, etc.)
- [ ] Documentation Update
- [ ] Other (please describe):

## Breaking change
Does this Pull Request cause existing functionality to not work as expected or even break. _Put an `x` in the boxes that apply_
- [ ] Yes
- [ ] No

## Solution Description
<!-- Describe your code changes in detail. Explain the technical solution you have provided and how it supports the project. Also explain why you chose the solution you did and what alternatives you considered, etc...-->

## How has this been tested?
<!--- Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc. -->

## Deploy Notes
<!-- Notes regarding deployment of your work. These should note any step, like db migrations, manual work, organizational stuff, etc.-->

## Impacted Areas
<!-- Please list parts of the project that this Pull Request will affect -->
- Area 1
- Area 2
- ...

## Related Issues
<!-- Please list and link to related issues -->
Issue Name | Issue Number
------------------| ----------------------------
FIRST ISSUE NAME | [#1](/user/project/issues/1)
SECOND ISSUE NAME | [#2](/user/project/issues/2)
... | ...

## Related Pull Requests
<!-- Please list and link related Pull Requests against other branches -->
Branch | Pull Request
----------------------| --------------------------
ft-NNN-NAME-TRACKERID | [#1](/user/project/pull/1)
bg-NNN-NAME-TRACKERID | [#2](/user/project/pull/2)
... | ...
Binary file added .media/UCK-G2-PLUS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# :cop: Code of Conduct

This Code of Conduct outlines expectations for participation in the community, as well as steps for reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all. People violating this code of conduct may be banned from the community.

This community strive to:

- __Be friendly and patient__: Remember you might not be communicating in someone else's primary spoken or programming language, and others may not have your level of understanding.
- __Be welcoming__: This community welcomes and support people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, color, immigration status, social and economic class, educational level, level of experience, sex, sexual identity and orientation, gender identity and expression, personal appearance, age, size, family status, political belief, religion, and mental and physical ability.
- __Be respectful__: This is a world-wide community of professionals, and we conduct ourselves professionally. Disagreement is no excuse for poor behavior and poor manners. Disrespectful and unacceptable behavior includes, but is not limited to:
- Violent threats or language.
- Discriminatory or derogatory jokes and language.
- Posting sexually explicit or violent material.
- Posting, or threatening to post, peoples personally identifying information ("doxing").
- Insults, especially those using discriminatory terms or slurs.
- Behavior that could be perceived as sexual attention.
- Trolling.
- Other conduct which could reasonably be considered inappropriate in a professional setting.
- Advocating for or encouraging any of the above behaviors.
- __Understand disagreements__: Disagreements, both social and technical, are useful learning opportunities. Seek to understand the other viewpoints and resolve differences constructively.
- This code is not exhaustive or complete. It serves to capture the common understanding of a productive, collaborative environment. We expect the code to be followed in spirit as much as in the letter.

## :telescope: Scope

This code of conduct applies to all repos and communities for our projects regardless of whether or not the repo explicitly calls out its use of this code. The code also applies in public spaces when an individual is representing a project or its community. Examples include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## :man_in_tuxedo: Responsibilities

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

Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## :mega: Reporting Code of Conduct Issues

Whenever possible, the community should try to resolve issues on their own. This builds a broader and deeper understanding and ultimately a healthier interaction. In the event that an issue cannot be resolved locally, please feel free to report your concerns by contacting [codeofconduct@essing.org](mailto:codeofconduct@essing.org).

In your report please include:
- Your contact information.
- Names (real, usernames or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well.
- Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public chat log), please include a link or attachment.
- Any additional information that may be helpful.

All reports will be reviewed and will result in a response that is deemed necessary and appropriate to the circumstances. Where additional perspectives are needed, we may seek insights from others with relevant expertise or experience. The confidentiality of the person reporting the incident will always be kept.

Anyone asked to stop unacceptable behavior is expected to comply immediately. If an individual engages in unacceptable behavior, we may take any action we deem appropriate, including a permanent ban from the community.

## :receipt: Attribution

This code of conduct is based on the template established by the [TODO Group](http://todogroup.org/) and used by numerous other large communities (e.g., [Microsoft](https://opensource.microsoft.com/codeofconduct/), [Facebook](https://code.facebook.com/pages/876921332402685/open-source-code-of-conduct), Twitter, GitHub and the Scope section from the [Contributor Covenant version 1.4](http://contributor-covenant.org/version/1/4/).
69 changes: 69 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# :construction_worker: Contributor's Guide

Below is the guidance for how to report issues, propose new features, and submit contributions via Pull Requests.

## :beetle: Before you start, file an issue

Please follow this simple rule to help us stop any unnecessary effort and frustration, so we all can ensure an efficient and effective use of everyone's time - yours, ours, and the time of other community members.

> If you have a question, or do you think you have discovered an issue, or would you like to propose a new feature, etc., then find/file an issue before starting work to fix or implement it.
>
>:exclamation: **For security issues please have a look at the [Security Policy](SECURITY.md)** :exclamation:
### :mag_right: Search existing issues first

Before filing a new issue, search existing open and closed issues first. Perhaps someone else has found the problem you are seeing, and someone may be working on or have already contributed a fix.

If no existing item describes your issue/feature, great - please file a new issue.

### :keyboard: File a new Issue

- You found a security issue and you want to report it? Please have a look at the [Security Policy](SECURITY.md).
- You have found a bug and you want to report it? Please file an issue with the tag "bug".
- You have found something critical, perhaps a bug where data can be lost, etc.? Please file an issue with the tag "critical".
- You got a great idea for a new feature? Please file an issue with the tag "feature".
- You have a question that you do not see answered in docs, videos, etc.? Please file an issue with the tag "documentation".
- You found an existing issue that describes yours? Great - please upvote and add additional commentary / info / repro-steps / etc.

### :pencil: Complete the template

Please include as much information as possible in your issue. The more information you provide, the more likely your issue/ask will be understood, accepted, and implemented.

- Do not assume somebody other than you is an expert in setting up your environment and do not assume somebody else is an expert in your workflow. Please tell us as much details you can, so we can help you as good as possible!
- What steps are needed to reproduce the issue? Assume we love to read repro steps. As much detail as you can stand is probably barely enough detail for us.
- We prefer error message text where possible, or screenshots of errors if the error text cannot be captured.
- If you intend to implement the fix/feature yourself, please say so! If you do not indicate you want to contribute, we assume that the issue is our to solve.

### :+1: Do not post "+1" comments

> Please do not post "+1", "me too", or similar comments - these comments just add noise to an issue.
If you do not have any additional information to add but would like to indicate that you are affected by the issue, upvote the original issue by clicking its :smiley:-button and hitting :+1: (+1) icon. This way it is much easier to measure how impactful an issue is.

---

## :man_technologist: Development

### :toolbox: Fork, Clone, Branch and Create your PR

Once you have filed an issue and discussed your proposed feature/fix, it is time to start development:

1. Fork the repo if you have not already
2. Clone your fork locally
3. Create & push a feature branch
4. Create a [Draft Pull Request](https://github.blog/2019-02-14-introducing-draft-pull-requests/)
5. Work on your changes

### :eyeglasses: Code Review

When you would like the project team to take a look, (even if the work is not yet fully-complete), mark the Pull Request as 'Ready For Review' so that the team can review your work and provide comments, suggestions, and request changes. We would like to encourage you to use the Pull Request as tool to start a conversation around your ideas and recruit people to help if necessary. It may take several cycles, but the result will be solid, testable, conformant code that is safe to merge.

### :jigsaw: Merge

Once your code has been reviewed and approved, it will be merged. Once merged, your Pull Request will be automatically closed.

---

## :balloon: Thank you

Thank you in advance for your contribution!
Loading

0 comments on commit e737508

Please sign in to comment.