Skip to content

Commit a99f1e9

Browse files
genoxgenox
authored
Initial commit
0 parents  commit a99f1e9

File tree

79 files changed

+8208
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+8208
-0
lines changed

‎.editorconfig‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#
2+
# __ __
3+
# / /____ ___ ____ ___ ___ _/ / This file is provided to you by https://github.com/tegonal/github-commons
4+
# / __/ -_) _ `/ _ \/ _ \/ _ `/ / Copyright 2022 Tegonal Genossenschaft <info@tegonal.com>
5+
# \__/\__/\_, /\___/_//_/\_,_/_/ It is licensed under Creative Commons Zero v1.0 Universal
6+
# /___/ Please report bugs and contribute back your improvements
7+
#
8+
# Version: v2.8.2
9+
###################################
10+
11+
# https://editorconfig.org
12+
13+
root = true
14+
15+
[*]
16+
charset = utf-8
17+
indent_style = tab
18+
end_of_line = lf
19+
insert_final_newline = true
20+
trim_trailing_whitespace = true
21+
22+
[*.md]
23+
insert_final_newline = false
24+
trim_trailing_whitespace = false
25+
26+
[*.{yml,yaml}]
27+
# tab is illegal as indentation character in yml files, hence we are opinionated here and use 2 spaces
28+
indent_style = space
29+
indent_size = 2
30+
31+
[*.bat]
32+
end_of_line = crlf

‎.gitattributes‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#
2+
# __ __
3+
# / /____ ___ ____ ___ ___ _/ / This file is provided to you by https://github.com/tegonal/github-commons
4+
# / __/ -_) _ `/ _ \/ _ \/ _ `/ / It is licensed under Creative Commons Zero v1.0 Universal
5+
# \__/\__/\_, /\___/_//_/\_,_/_/ Please report bugs and contribute back your improvements
6+
# /___/
7+
# Version: v1.2.0-SNAPSHOT
8+
#
9+
###################################
10+
11+
# https://help.github.com/articles/dealing-with-line-endings/
12+
13+
# These are explicitly windows files and should use crlf
14+
*.bat text eol=crlf
15+

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
<!--
2+
#
3+
# __ __
4+
# / /____ ___ ____ ___ ___ _/ / This file is provided to you by https://github.com/tegonal/github-commons
5+
# / __/ -_) _ `/ _ \/ _ \/ _ `/ / Copyright 2022 Tegonal Genossenschaft <info@tegonal.com>
6+
# \__/\__/\_, /\___/_//_/\_,_/_/ It is licensed under Creative Commons Zero v1.0 Universal
7+
# /___/ Please report bugs and contribute back your improvements
8+
#
9+
# Version: v2.8.2
10+
###################################
11+
-->
12+
# Contributor Covenant Code of Conduct
13+
14+
## Our Pledge
15+
16+
We as members, contributors, and leaders pledge to make participation in our
17+
community a harassment-free experience for everyone, regardless of age, body
18+
size, visible or invisible disability, ethnicity, sex characteristics, gender
19+
identity and expression, level of experience, education, socio-economic status,
20+
nationality, personal appearance, race, caste, color, religion, or sexual
21+
identity and orientation.
22+
23+
We pledge to act and interact in ways that contribute to an open, welcoming,
24+
diverse, inclusive, and healthy community.
25+
26+
## Our Standards
27+
28+
Examples of behavior that contributes to a positive environment for our
29+
community include:
30+
31+
* Demonstrating empathy and kindness toward other people
32+
* Being respectful of differing opinions, viewpoints, and experiences
33+
* Giving and gracefully accepting constructive feedback
34+
* Accepting responsibility and apologizing to those affected by our mistakes,
35+
and learning from the experience
36+
* Focusing on what is best not just for us as individuals, but for the overall
37+
community
38+
39+
Examples of unacceptable behavior include:
40+
41+
* The use of sexualized language or imagery, and sexual attention or advances of
42+
any kind
43+
* Trolling, insulting or derogatory comments, and personal or political attacks
44+
* Public or private harassment
45+
* Publishing others' private information, such as a physical or email address,
46+
without their explicit permission
47+
* Other conduct which could reasonably be considered inappropriate in a
48+
professional setting
49+
50+
## Enforcement Responsibilities
51+
52+
Community leaders are responsible for clarifying and enforcing our standards of
53+
acceptable behavior and will take appropriate and fair corrective action in
54+
response to any behavior that they deem inappropriate, threatening, offensive,
55+
or harmful.
56+
57+
Community leaders have the right and responsibility to remove, edit, or reject
58+
comments, commits, code, wiki edits, issues, and other contributions that are
59+
not aligned to this Code of Conduct, and will communicate reasons for moderation
60+
decisions when appropriate.
61+
62+
## Scope
63+
64+
This Code of Conduct applies within all community spaces, and also applies when
65+
an individual is officially representing the community in public spaces.
66+
Examples of representing our community include using an official e-mail address,
67+
posting via an official social media account, or acting as an appointed
68+
representative at an online or offline event.
69+
70+
## Enforcement
71+
72+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
73+
reported to the community leaders responsible for enforcement at
74+
<OWNER_EMAIL>.
75+
All complaints will be reviewed and investigated promptly and fairly.
76+
77+
All community leaders are obligated to respect the privacy and security of the
78+
reporter of any incident.
79+
80+
## Enforcement Guidelines
81+
82+
Community leaders will follow these Community Impact Guidelines in determining
83+
the consequences for any action they deem in violation of this Code of Conduct:
84+
85+
### 1. Correction
86+
87+
**Community Impact**: Use of inappropriate language or other behavior deemed
88+
unprofessional or unwelcome in the community.
89+
90+
**Consequence**: A private, written warning from community leaders, providing
91+
clarity around the nature of the violation and an explanation of why the
92+
behavior was inappropriate. A public apology may be requested.
93+
94+
### 2. Warning
95+
96+
**Community Impact**: A violation through a single incident or series of
97+
actions.
98+
99+
**Consequence**: A warning with consequences for continued behavior. No
100+
interaction with the people involved, including unsolicited interaction with
101+
those enforcing the Code of Conduct, for a specified period of time. This
102+
includes avoiding interactions in community spaces as well as external channels
103+
like social media. Violating these terms may lead to a temporary or permanent
104+
ban.
105+
106+
### 3. Temporary Ban
107+
108+
**Community Impact**: A serious violation of community standards, including
109+
sustained inappropriate behavior.
110+
111+
**Consequence**: A temporary ban from any sort of interaction or public
112+
communication with the community for a specified period of time. No public or
113+
private interaction with the people involved, including unsolicited interaction
114+
with those enforcing the Code of Conduct, is allowed during this period.
115+
Violating these terms may lead to a permanent ban.
116+
117+
### 4. Permanent Ban
118+
119+
**Community Impact**: Demonstrating a pattern of violation of community
120+
standards, including sustained inappropriate behavior, harassment of an
121+
individual, or aggression toward or disparagement of classes of individuals.
122+
123+
**Consequence**: A permanent ban from any sort of public interaction within the
124+
community.
125+
126+
## Attribution
127+
128+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
129+
version 2.1, available at
130+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
131+
132+
Community Impact Guidelines were inspired by
133+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
134+
135+
For answers to common questions about this code of conduct, see the FAQ at
136+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
137+
[https://www.contributor-covenant.org/translations][translations].
138+
139+
[homepage]: https://www.contributor-covenant.org
140+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
141+
[Mozilla CoC]: https://github.com/mozilla/diversity
142+
[FAQ]: https://www.contributor-covenant.org/faq
143+
[translations]: https://www.contributor-covenant.org/translations
144+

‎.github/CONTRIBUTING.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Contributing to PROJECT_NAME
2+
3+
Thank you very much for taking your time to contribute to PROJECT_NAME :smiley:
4+
5+
Following a few guidelines so that others can quickly benefit from your contribution.
6+
7+
*Table of Content*: [Code of Conduct](#code-of-conduct), [How to Contribute](#how-to-contribute),
8+
[Your First Code Contribution](#your-first-code-contribution),
9+
[Pull Request Checklist](#pull-request-checklist).
10+
11+
## Code of Conduct
12+
This project and everyone participating in it is governed by this project's
13+
[Code of Conduct](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/tree/main/.github/CODE_OF_CONDUCT.md).
14+
By participating, you are expected to uphold this code. Please report unacceptable behaviour to ORG_EMAIL
15+
16+
## How to Contribute
17+
- Star PROJECT_NAME if you like it.
18+
19+
- Need help using a feature?
20+
Open a [new discussion](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/discussions/new?category=q-a)
21+
and write down your question there and we will get back to you.
22+
23+
- Found a bug?
24+
[Open an issue](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/issues/new?template=bug_report.md).
25+
26+
- Missing a feature?
27+
Open a [new discussion](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/discussions/new?category=ideas)
28+
and write down your need and we will get back to you.
29+
30+
- Found spelling mistakes?
31+
Nice catch 🧐 Please fix it and create a pull request.
32+
33+
In any case, if you are uncertain how you can contribute, then contact us via a
34+
[new discussion](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/discussions/new?category=contributor-q-a)
35+
and we will figure it out together :smile:
36+
37+
## Your First Code Contribution
38+
Fantastic, thanks for your effort!
39+
40+
The following are a few guidelines on how we suggest you start.
41+
42+
1. Fork the repository to your repositories (see [Fork a repo](https://help.github.com/en/articles/fork-a-repo) for help).
43+
2. Read up the [Pull Request Checklist](#pull-request-checklist)
44+
45+
Perfect, you are setup and ready to go.
46+
Have a look at [help wanted issues](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
47+
where [good first issues](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
48+
are easier to start with.
49+
Please write a comment such as `I'll work on this` in the issue,
50+
this way we can assign the task to you (so that others know there is already someone working on the issue)
51+
and it gives us the chance to have a look at the description again and revise if necessary.
52+
53+
<a name="git"></a>
54+
*Git*
55+
56+
Dealing with Git for the first time? Here are some recommendations for how to set up Git when working on an issue:
57+
- create a new branch for the issue using `git checkout -b <branch-name>` (preferably, the branch name
58+
should be descriptive of the issue or the change being made, e.g `#108-path-exists`.) Working
59+
on a new branch makes it easier to make more than one pull request.
60+
- add this repository as a remote repository using
61+
`git remote add upstream https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB.git`. You will use this to
62+
fetch changes made in this repository.
63+
- to ensure your branch is up-to-date, rebase your work on
64+
upstream/main using `git rebase upstream/main` or `git pull -r upstream main`.
65+
This will add all new changes in this repository into your branch and place your
66+
local unpushed changes at the top of the branch.
67+
68+
You can read more on Git [here](https://git-scm.com/book/).
69+
Contact us via a [new discussion](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/discussions/new?category=contributor-q-a)
70+
whenever you need help to get up and running or have questions.
71+
72+
*Create a Draft*
73+
74+
We recommend you create a pull request (see [About pull requests](https://help.github.com/en/articles/about-pull-requests) for help)
75+
in case you are not sure how you should do something.
76+
This way we can give you fast feedback regarding multiple things (style, does it go in the right direction etc.) before you spend time for nothing.
77+
Prepend the title with `[WIP]` (work in progress) or mark it as draft and leave a comment with your questions.
78+
79+
*Push your changes and create a PR*
80+
81+
Finally, when you think your PR (short for pull request) is ready, then please:
82+
83+
1. read the [Pull Request Checklist](#pull-request-checklist)
84+
2. Create your first pull-request
85+
3. 👏👏👏 you have submitted your first code contribution to ORG_NAME_GITHUB/PROJECT_NAME_GITHUB 😊
86+
87+
88+
## Pull Request Checklist
89+
Please make sure you can check every item on the following list before you create a pull request:
90+
- [ ] your pull request is rebased on the [latest commit on main](https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB/commits/main)
91+
- [ ] Your pull request addresses only “one thing”. It cannot be meaningfully split up into multiple pull requests.
92+
- [ ] There is no error if you run ./scripts/before-pr.sh
93+
- [ ] Make sure you have no changes after running ./scripts/before-pr.sh and `git commit --amend` otherwise
94+
95+
Once you have created and submitted your pull request, make sure:
96+
- [ ] your pull request passes Continuous Integration

0 commit comments

Comments
 (0)