Skip to content

Commit ab49ade

Browse files
committed
Updated community documentation
1 parent 23cab11 commit ab49ade

14 files changed

+167
-22
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @vonhoff

.github/FUNDING.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
# These are supported funding model platforms
2-
31
github: vonhoff
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help this project improve.
4+
title: "bug: "
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
## Bug Report
10+
11+
**Detailed Description**
12+
13+
<!-- Describe how the bug manifests and what the behavior would be without the bug. -->
14+
15+
**Reproduction Steps**
16+
17+
<!-- Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
18+
19+
**Other Information**
20+
21+
<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project.
4+
title: "feat: "
5+
labels: "enhancement"
6+
assignees: ""
7+
---
8+
9+
## Feature Request
10+
11+
**Detailed Description**
12+
13+
<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->
14+
15+
**Additional Context**
16+
17+
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Codebase Improvement
3+
about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc.
4+
title: "dev: "
5+
labels: "enhancement"
6+
assignees: ""
7+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Support Question
3+
about: Question on how to use this project.
4+
title: "support: "
5+
labels: "question"
6+
assignees: ""
7+
---

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- Summarize your changes in the title -->
2+
3+
**Motivation and Context**
4+
5+
<!-- Why is this change needed? Link any relevant issues. -->
6+
7+
**Additional Info**
8+
9+
<!-- Any other relevant information, e.g., screenshots, references -->

CHANGES.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 70 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,76 @@
11
# Code of Conduct
22

3-
The guidelines in this Code of Conduct are intended to ensure an environment that is safe, respectful, and inclusive. These guidelines apply to any interaction within the project, including issues, pull requests, comments, and discussions.
3+
## Our Pledge
44

5-
## Guidelines
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
611

7-
- Respect differing opinions and perspectives.
8-
- Assume good intentions in all interactions.
9-
- Personal attacks and derogatory remarks will not be tolerated.
10-
- Harassment and discriminatory behavior will not be tolerated.
12+
## Our Standards
1113

12-
## Focus on Collaboration
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
1316

14-
All discussions should remain relevant to the project's goals. Topics that are political or unrelated are discouraged unless they directly relate to the project's objectives or community.
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at `simon.vonhoff[at]outlook.com`. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)