generated from templates/repo-template
Initial commit
commit
c6f9a7a9ce
@ -0,0 +1,14 @@
|
||||
# reference: https://editorconfig.org/
|
||||
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[Makefile]
|
||||
indent_style = tab
|
@ -0,0 +1,16 @@
|
||||
# reference: https://git-scm.com/docs/gitattributes
|
||||
|
||||
# end of line conversion
|
||||
|
||||
* text=auto
|
||||
|
||||
# ignore for export / release
|
||||
|
||||
/tests export-ignore
|
||||
/tools export-ignore
|
||||
|
||||
.editorconfig export-ignore
|
||||
.gitattributes export-ignore
|
||||
.gitignore export-ignore
|
||||
.gitmessages export-ignore
|
||||
.yamllint export-ignore
|
@ -0,0 +1,36 @@
|
||||
---
|
||||
# reference: https://docs.gitea.io/en-us/issue-pull-request-templates/
|
||||
|
||||
name: "Bug report"
|
||||
about: "I want to report a bug."
|
||||
title: "[BUG] "
|
||||
labels:
|
||||
|
||||
- "bug"
|
||||
|
||||
---
|
||||
|
||||
**Description**
|
||||
|
||||
<!-- Please describe the issue, as detailed as possible. -->
|
||||
|
||||
**Steps to reproduce**
|
||||
|
||||
<!-- Please describe the procedure to reproduce the issue. -->
|
||||
|
||||
1. Do this...
|
||||
2. Click on ...
|
||||
3. Execute command `this command`...
|
||||
|
||||
**Result behavior**
|
||||
|
||||
<!-- Please describe the results you received. -->
|
||||
|
||||
**Expected behavior**
|
||||
|
||||
<!-- Please describe the results you expect. -->
|
||||
|
||||
**Additional information**
|
||||
|
||||
<!-- Please add information like the used software versions, outputs of logs,
|
||||
OS information, screenshots, etc. to enhance the report. -->
|
@ -0,0 +1,23 @@
|
||||
---
|
||||
# reference: https://docs.gitea.io/en-us/issue-pull-request-templates/
|
||||
|
||||
name: "Feature request"
|
||||
about: "I think, this can be improved."
|
||||
title: "[Feature] "
|
||||
labels:
|
||||
|
||||
- "enhancement"
|
||||
|
||||
---
|
||||
|
||||
**Description**
|
||||
|
||||
<!-- Please describe the issue, as detailed as possible. -->
|
||||
|
||||
**Use case**
|
||||
|
||||
<!-- Please describe why and where this feature would be helpful. -->
|
||||
|
||||
**Additional information**
|
||||
|
||||
<!-- Please add information like mockups, code snippets, flow diagrams, etc. -->
|
@ -0,0 +1,16 @@
|
||||
---
|
||||
# reference: https://docs.gitea.io/en-us/issue-pull-request-templates/
|
||||
|
||||
name: "Question"
|
||||
about: "I have a question."
|
||||
title: "[Question] "
|
||||
labels:
|
||||
|
||||
- "question"
|
||||
|
||||
---
|
||||
|
||||
**Question**
|
||||
|
||||
<!-- Please ask your question below. It is recommended to give some background
|
||||
and describe the topic as detailed as possible. -->
|
@ -0,0 +1,52 @@
|
||||
# reference: https://git-scm.com/docs/gitignore
|
||||
|
||||
# ansible
|
||||
*.retry
|
||||
|
||||
# compiled source
|
||||
bin/
|
||||
*.com
|
||||
*.class
|
||||
*.dll
|
||||
*.exe
|
||||
*.o
|
||||
*.so
|
||||
|
||||
# database
|
||||
*.sql
|
||||
*.sqlite
|
||||
|
||||
# lock files
|
||||
*.lock
|
||||
package-lock.json
|
||||
|
||||
# logs
|
||||
logs/
|
||||
*.log
|
||||
|
||||
# OS generated files
|
||||
.DS_Store*
|
||||
ehthumbs.db
|
||||
Icon?
|
||||
Thumbs.db
|
||||
|
||||
# packages
|
||||
*.7z
|
||||
*.dmg
|
||||
*.gz
|
||||
*.iso
|
||||
*.rar
|
||||
*.tar
|
||||
*.zip
|
||||
|
||||
# python
|
||||
*.py[cod]
|
||||
__pycache__/
|
||||
|
||||
# temporary files
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Vagrant
|
||||
.vagrant/
|
@ -0,0 +1,28 @@
|
||||
#<--- 72 characters --------------------------------------------------->
|
||||
#
|
||||
# Thank you so much for your contribution! Below you can find the
|
||||
# pattern, some explanation and an example for a proper commit message.
|
||||
# Please also consider to edit your contribution in the 'KUDOS.txt' in
|
||||
# the repository.
|
||||
#
|
||||
#<--- pattern --------------------------------------------------------->
|
||||
#
|
||||
# (Feature|Fix|Refactor|Document): <SUBJECT>
|
||||
#
|
||||
# The body, explains the change a little bit more. You can:
|
||||
#
|
||||
# - you can use
|
||||
# - bullet points
|
||||
#
|
||||
# Adding a footer to address the issue is recommended.
|
||||
#
|
||||
# - resolves: #0815
|
||||
# - addresses: #4711
|
||||
#
|
||||
#<--- usage ----------------------------------------------------------->
|
||||
#
|
||||
# To apply this kind of template, you can configure git.
|
||||
#
|
||||
# `git config commit.template .gitmessage`
|
||||
#
|
||||
#<--- 72 characters --------------------------------------------------->
|
@ -0,0 +1,18 @@
|
||||
---
|
||||
# reference: https://yamllint.readthedocs.io/
|
||||
|
||||
extends: "default"
|
||||
|
||||
rules:
|
||||
|
||||
braces:
|
||||
max-spaces-inside: 1
|
||||
level: "error"
|
||||
|
||||
brackets:
|
||||
max-spaces-inside: 1
|
||||
level: "error"
|
||||
|
||||
quoted-strings:
|
||||
quote-type: "any"
|
||||
required: true
|
@ -0,0 +1,53 @@
|
||||
<!--
|
||||
reference: https://keepachangelog.com
|
||||
-->
|
||||
|
||||
# Changelog
|
||||
|
||||
## [MAJOR.MINOR.PATCH-LABEL] - YYYY-MM-DD
|
||||
|
||||
<!--
|
||||
Describe the purpose of this release.
|
||||
Each of the below sections should contain the links to the fixed issues.
|
||||
-->
|
||||
|
||||
### Security
|
||||
|
||||
<!--
|
||||
Optional Section for security relevant patches
|
||||
-->
|
||||
|
||||
### Added
|
||||
|
||||
<!--
|
||||
Section for new Features and Additions.
|
||||
Most likely a MINOR or MAJOR update.
|
||||
-->
|
||||
|
||||
### Changed
|
||||
|
||||
<!--
|
||||
Changed Behavior in API or Application.
|
||||
Most likely a MAJOR update.
|
||||
-->
|
||||
|
||||
### Deprecated
|
||||
|
||||
<!--
|
||||
Deprecation, which will be removed in a future release.
|
||||
The future release must be mentioned.
|
||||
-->
|
||||
|
||||
### Removed
|
||||
|
||||
<!--
|
||||
Removals or Deletions, which were deprecated beforehand.
|
||||
Most likely a Minor or Major update.
|
||||
-->
|
||||
|
||||
### Fixed
|
||||
|
||||
<!--
|
||||
Bugfixes or other minor fixes.
|
||||
Most likely a patch.
|
||||
-->
|
@ -0,0 +1,39 @@
|
||||
---
|
||||
# reference: https://kudos-txt.io
|
||||
|
||||
project:
|
||||
|
||||
- name: "while-true-do.io"
|
||||
site: "https://while-true-do.io"
|
||||
code: "https://code.while-true-do.io"
|
||||
mail: "hello@while-true-do.io"
|
||||
chat: "freenode #while-true-do"
|
||||
|
||||
contributor:
|
||||
|
||||
- name: "<name or handle>"
|
||||
role: "Owner"
|
||||
site: "<website url>"
|
||||
blog: "<blog url>"
|
||||
mail: "<mail@domain.tld>"
|
||||
chat: "<service:nick>, <service:channel>, <url>"
|
||||
home: "<country>, <region>, <zip>, <city>, <address>"
|
||||
work: "<company>, <job title>, <job description>"
|
||||
note: "<free text notes>"
|
||||
|
||||
partner:
|
||||
|
||||
- name: "KUDOS.txt"
|
||||
site: "https://kudos-txt.io"
|
||||
code: "https://https://code.while-true-do.io/kudos-txt"
|
||||
mail: "hello@kudos-txt.io"
|
||||
|
||||
- name: "style-cheat"
|
||||
site: "https://style-cheat.io"
|
||||
code: "https://code.while-true-do.io/style-cheat"
|
||||
mail: "hello@style-cheat.io"
|
||||
|
||||
- name: "gerri"
|
||||
site: "https://gerri.io"
|
||||
code: "https://code.while-true-do.io/gerri"
|
||||
mail: "hello@gerri.io"
|
@ -0,0 +1,29 @@
|
||||
BSD 3-Clause License
|
||||
|
||||
Copyright (c) 2021, while-true-do.io
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
@ -0,0 +1,147 @@
|
||||
<!--
|
||||
reference: https://www.makeareadme.com/
|
||||
reference: https://commonmark.org/
|
||||
-->
|
||||
|
||||
# gerri.io
|
||||
|
||||
The gerri.io website
|
||||
|
||||
## Motivation
|
||||
|
||||
<!-- TODO: Motivation
|
||||
|
||||
This section describes the motivation to create the code.
|
||||
|
||||
Why is this repository needed?
|
||||
Which problem is solved?
|
||||
Who may need it?
|
||||
-->
|
||||
|
||||
## Description
|
||||
|
||||
<!-- TODO: Description
|
||||
|
||||
This section describes the product/code itself. Feel free to use subsections
|
||||
to showcase Features, Pictures, Diagrams, etc.
|
||||
|
||||
What does this repository provide?
|
||||
What does it not provide?
|
||||
Which features are covered?
|
||||
|
||||
Optional: Add subsections for features, screenshots, etc.
|
||||
-->
|
||||
|
||||
## Requirements
|
||||
|
||||
<!-- TODO: Requirements
|
||||
|
||||
This section describes what one needs to run the code in production.
|
||||
|
||||
What is needed beforehand?
|
||||
What are prerequisites to start with an installation?
|
||||
Are there any dependencies, that needs to be solved?
|
||||
|
||||
Optional: Use and link a docs/REQUIREMENTS.md
|
||||
-->
|
||||
|
||||
## Install
|
||||
|
||||
<!-- TODO: Install
|
||||
|
||||
This section describes how to install the product to actually use it.
|
||||
|
||||
How to install the content?
|
||||
Are there manual steps?
|
||||
Providing a step-by-step guide is recommended.
|
||||
|
||||
Optional: Use and link a docs/INSTALL.md
|
||||
-->
|
||||
|
||||
## Usage
|
||||
|
||||
<!-- TODO: Usage
|
||||
|
||||
This section describes how to use the product.
|
||||
|
||||
How to use the content?
|
||||
Can you provide some simple examples?
|
||||
Can you provide enhanced examples?
|
||||
|
||||
Optional: Use and link a docs/USAGE.md
|
||||
-->
|
||||
|
||||
## Known Issues
|
||||
|
||||
<!-- TODO: Known Issues
|
||||
|
||||
This section is reserved to list known issues.
|
||||
|
||||
Is there something broken?
|
||||
Are workarounds present?
|
||||
-->
|
||||
|
||||
## Changelog
|
||||
|
||||
The repository contains a curated, chronological [changelog](CHANGELOG.md),
|
||||
maintained by the owner for each release/tag.
|
||||
|
||||
## Contribute
|
||||
|
||||
Thank you so much for considering to contribute! We are happy, when someone is
|
||||
joining the hard work. Please feel free to contribute, after having a look at
|
||||
the Conventions.
|
||||
|
||||
- [Bugs and Feature Requests](https://code.while-true-do.io/gerri/gerri.io/issues)
|
||||
- [Pull Requests](https://code.while-true-do.io/gerri/gerri.io/pulls)
|
||||
|
||||
<!-- TODO: Contribute
|
||||
|
||||
Please review and tweak the KUDOS.txt file.
|
||||
-->
|
||||
|
||||
See who has contributed already in the [KUDOS.txt](KUDOS.txt).
|
||||
|
||||
## Develop
|
||||
|
||||
<!-- TODO: Develop
|
||||
|
||||
This section describes how one can start to help developing the code.
|
||||
|
||||
How to setup the development environment?
|
||||
Are there special requirements?
|
||||
Do you suggest / recommend something for developers?
|
||||
|
||||
Optional: Use and link a docs/DEVELOP.md
|
||||
-->
|
||||
|
||||
## Test
|
||||
|
||||
<!-- TODO: Test
|
||||
|
||||
Add your guideline, how to test.
|
||||
How to execute the tests locally?
|
||||
What is automatically done?
|
||||
|
||||
Optional: Use and link a docs/TEST.md
|
||||
Optional: Provide additional test scripts and helpers in tests/
|
||||
-->
|
||||
|
||||
## License
|
||||
|
||||
<!-- TODO: License
|
||||
|
||||
Please review and adjust the LICENSE, if needed.
|
||||
-->
|
||||
|
||||
Except where otherwise noted, all work is [licensed](LICENSE) under a
|
||||
[BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).
|
||||
|
||||
## Contact
|
||||
|
||||
Please feel free to get in touch with the developers and contributors.
|
||||
|
||||
- Site <https://while-true-do.io>
|
||||
- Code <https://code.while-true-do.io>
|
||||
- Mail [hello@while-true-do.io](mailto:hello@while-true-do.io)
|
||||
- Chat [@freenode #while-true-do](https://webchat.freenode.net/#while-true-do)
|
@ -0,0 +1,135 @@
|
||||
<!--
|
||||
reference: https://www.contributor-covenant.org
|
||||
-->
|
||||
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
[while-true-do.io](https://while-true-do.io) 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
|
||||
[INSERT CONTACT METHOD].
|
||||
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][https://www.contributor-covenant.org], 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>.
|
@ -0,0 +1,44 @@
|
||||
# Contributing Guide
|
||||
|
||||
[while-true-do.io](https://while-true-do.io) Code Contributing Guideline
|
||||
|
||||
## Welcome
|
||||
|
||||
First off, thanks for taking time to contribute. We really appreciate every
|
||||
contribution in form of reports, requests, discussions or every other bit,
|
||||
that will help to grow the project.
|
||||
|
||||
Please read the below text carefully before contributing.
|
||||
|
||||
## Bug Reports
|
||||
|
||||
Reporting Bugs should follow some simple rules:
|
||||
|
||||
- **Check**, if you can find similar bugs
|
||||
- **Describe** what is happening and what should happen
|
||||
- **Explain** why this is a problem
|
||||
- **Add** more details and attachments
|
||||
- **Follow up**, if somebody is having questions or needs more details
|
||||
|
||||
## Feature Requests
|
||||
|
||||
Requesting a new feature is also following some simple rules:
|
||||
|
||||
- **Check**, if the feature is already requested
|
||||
- **Describe** what your feature will bring to the community
|
||||
- **Explain** the criteria to fulfill the request
|
||||
- **Add** more details like mock ups, attachments, lists, screenshots
|
||||
- **Follow Up** in the discussion to the feature
|
||||
|
||||
## Code Contribution
|
||||
|
||||
Contributing code should be as easy as possible. Therefore, all needed
|
||||
information should be present in the repository's [README.md](../README.md).
|
||||
In general, we are following the below process.
|
||||
|
||||
- **File an issue** for each code contribution (see above)
|
||||
- **One Contribution** should solve **one issue**
|
||||
- **Tested** code is **cool** code
|
||||
- **Documented** code is **maintainable** code
|
||||
- **Commit Messages** should be meaningful and self explaining (see .gitmessage)
|
||||
- **Rebase** before opening the pull request
|
@ -0,0 +1 @@
|
||||
TODO: Remove this file or directory, if not needed
|
Loading…
Reference in New Issue