Skip to content

Commit

Permalink
docs: add some legal files and templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
yagizhanNY committed May 10, 2024
1 parent ac37412 commit 11c3501
Show file tree
Hide file tree
Showing 12 changed files with 454 additions and 1 deletion.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Bug Report
description: Bug report 📚
labels: ['triage']
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Prerequisites
description: Make sure to not violate these rules
options:
- label: I have read the [Contributing Guidelines](https://github.com/siemens/ix/blob/main/CONTRIBUTING.md).
required: true
- label: I have not leaked any internal/restricted information like screenshots, videos, code snippets, links etc.
required: true

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the issue here.
placeholder: Tell us what you see!
validations:
required: true

- type: checkboxes
attributes:
label: Prerequisites
description: Make sure you are using correct .NET version.
options:
- label: I am using .NET8.
required: true

- type: input
id: version
attributes:
label: Which version of SiemensIXBlazor package do you use?
description: The exact version of SiemensIXBlazor you use.
placeholder: 0.x.x
validations:
required: true

- type: textarea
id: logs
attributes:
label: Code to produce this issue.
description: |
Please provide accessible code (no private repositories) to reproduce the problem (__preferred__ github repository).
Issues without code to reproduce can not be analyzed by the team.
render: shell
validations:
required: true
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Support Question 🤔
url: https://community.siemens.com/c/ix/
about: This issue tracker is not for support questions. Please post your question to the Siemens Community Forum.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Bug Report for the official iXBlazor documentation
description: Documentation bug report 📑
labels: ['component: documentation', 'triage']
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Prerequisites
description: Make sure to not violate these rules
options:
- label: I have read the [Contributing Guidelines](https://github.com/siemens/ix/blob/main/CONTRIBUTING.md).
required: true
- label: I have not leaked any internal/restricted information like screenshots, videos, code snippets, links etc.
required: true

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the issue here.
placeholder: Tell us what you see!
validations:
required: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature request
description: Suggest a feature / idea for this project
labels: ['type: enhancement', 'triage']
body:
- type: markdown
attributes:
value: |
We appreciate your feedback on how to improve this project.
- type: checkboxes
attributes:
label: Prerequisites
description: Make sure to not violate these rules
options:
- label: I have read the [Contributing Guidelines](https://github.com/siemens/ix/blob/main/CONTRIBUTING.md).
required: true
- label: I have not leaked any internal/restricted information like screenshots, videos, code snippets, links etc.
required: true

- type: textarea
id: Suggestion
attributes:
label: Suggestion / feature request
description: Describe the feature(s) you would like to see added.
placeholder: Tell us your suggestion
value: 'Your suggestion here'
validations:
required: true
3 changes: 3 additions & 0 deletions .gitmessage
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<type>(<scope>): <summary> #<issue number>

# ────────────────────────────────────────── 100 chars ────────────────────────────────────────────┤
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 Siemens AG
SPDX-License-Identifier: MIT
-->

```
Will be filled after version 0.5.0
```
121 changes: 121 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<!--
SPDX-FileCopyrightText: 2024 Siemens AG
SPDX-License-Identifier: MIT
-->

# Code of Conduct - SiemensIXBlazor

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, 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.

## Our Standards

Examples of behaviour 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 apologising 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 behaviour include:

* The use of sexualised language or imagery, and sexual attention or advances
* 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

## Our Responsibilities

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

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, 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 behaviour may be
reported to the community leaders responsible for enforcement at <[email protected]>.
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 behaviour 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
behaviour 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 behaviour. 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 behaviour.

**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 behaviour, 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://contributor-covenant.org/), version
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
Loading

0 comments on commit 11c3501

Please sign in to comment.