Skip to content

Commit dc9d876

Browse files
geffrakmchesnay
geffrak
and
mchesnay
authored
Code of conduct, issue templates, pull request template and codeowners (AcademySoftwareFoundation#64)
<!-- Thanks for your contribution! Please read this comment in its entirety. It's quite important. When a contributor will merge the pull request, the title and the description will be used to build the merge commit! ### Pull Request TITLE It should be in the following format: [ 12345: Summary of the changes made ] Where 12345 is the corresponding Github Issue OR [ Summary of the changes made ] If it's solving something trivial, like fixing a typo. --> ### Linked issues <!-- Link the Issue(s) this Pull Request is related to. Each PR should link at least one issue, in the form: Use one line for each Issue. This allows auto-closing the related issue when the fix is merged. Fixes AcademySoftwareFoundation#123 Fixes AcademySoftwareFoundation#456 --> No linked issue ### Summarize your change. Adds code of conduct, issue templates, pull request templates and CODEOWNER files. Note: I filled this pull request by manually copying the pull request template :) If you try to edit the pull request description, you see all the comments. ### Describe the reason for the change. I am trying to implement the missing bits of the [Community Standards](https://github.com/AcademySoftwareFoundation/OpenRV/community) checklist. <img width="1650" alt="Community Standards Screenshot" src="https://user-images.githubusercontent.com/6785406/219745446-c81e4008-3d31-487b-bf94-313c79d93642.png"> ### Describe what you have tested and on what operating system. N/A ### Add a list of changes, and note any that might need special attention during the review. Please watchout for typos. I am known for injecting them everywhere I go. ### If possible, provide some screenshots. <img width="1650" alt="Pull Request Template Edit" src="https://user-images.githubusercontent.com/6785406/219750950-1c9b8398-7139-4297-a0e9-b49e0bc3b6b2.png"> <img width="1650" alt="Pull Request Template Preview" src="https://user-images.githubusercontent.com/6785406/219750999-50a51330-a7bf-4f4e-a263-c6c15dfd7a01.png"> <img width="1650" alt="Create an Issue" src="https://user-images.githubusercontent.com/6785406/219751134-08439da4-4332-484d-a33e-14d3ba90a194.png"> <img width="1650" alt="Create a Bug Report" src="https://user-images.githubusercontent.com/6785406/219751165-6323afcd-ce5f-4696-89d0-b14a231aefcb.png"> <!-- Use the Preview tab to ensure everything looks like you expect. --> --------- Signed-off-by: Kerby Geffrard <[email protected]> Co-authored-by: Martin Chesnay <[email protected]>
1 parent ef48548 commit dc9d876

File tree

5 files changed

+255
-0
lines changed

5 files changed

+255
-0
lines changed

‎.github/CODEOWNERS

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# See https://help.github.com/articles/about-codeowners/
2+
# for more info about CODEOWNERS file
3+
4+
# It uses the same pattern rule for gitignore file
5+
# https://git-scm.com/docs/gitignore#_pattern_format
6+
7+
* @AcademySoftwareFoundation/rvos-committers

‎.github/ISSUE_TEMPLATE/bug.yml

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug Report
2+
3+
description: File a bug report
4+
5+
title: "[Bug]: <title>"
6+
7+
labels: ["bug"]
8+
9+
assignees:
10+
- AcademySoftwareFoundation/rvos-committers
11+
12+
body:
13+
- type: markdown
14+
attributes:
15+
value: |
16+
Thanks for taking the time to fill out this bug report! Before submitting it, please make sure it's not already covered by another issue (open or closed).
17+
18+
- type: textarea
19+
id: what-happened
20+
attributes:
21+
label: What happened?
22+
description: When possible, include steps to reproduce the bug. Also, what behaviour did you expect?
23+
placeholder: Tell us what you see!
24+
value: "A bug happened!"
25+
validations:
26+
required: true
27+
28+
- type: input
29+
id: operating-system-version
30+
attributes:
31+
label: List all the operating systems versions where this is happening
32+
placeholder: Windows 10, macOS 12, macOS 13.2.1, RHEL 7.6
33+
validations:
34+
required: true
35+
36+
- type: input
37+
id: hardware
38+
attributes:
39+
label: On what computer hardware is this happening?
40+
description: Workstation type, GPU type, CPU + Number of Cores, Memory / RAM, Storage type, etc.
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: logs
46+
attributes:
47+
label: Relevant console log output
48+
description: Please copy and paste any relevant log output. This will be automatically formatted, so no need for backticks.
49+
render: shell
50+
51+
- type: textarea
52+
id: environment
53+
attributes:
54+
label: Environment variables
55+
description: Please copy and paste any relevant environment variables. They can be accessed through the "Help / Show environment" menu.
56+
57+
- type: textarea
58+
id: extra
59+
attributes:
60+
label: Extra information
61+
description: Please share anything else that might be relevant. RV Preference override? Significant behavior change because of a package?
62+
63+
- type: checkboxes
64+
id: terms
65+
attributes:
66+
label: Code of Conduct
67+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct)
68+
options:
69+
- label: I agree to follow this project's Code of Conduct
70+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: yes
2+
3+
contact_links:
4+
- name: "Proposing new features"
5+
url: "https://github.com/AcademySoftwareFoundation/OpenRV/discussions/categories/ideas"
6+
about: "Post a message to the 'idea' category"
7+
8+
- name: "Discussing with the OpenRV community"
9+
url: "https://github.com/AcademySoftwareFoundation/OpenRV/discussions/categories/general"
10+
about: "Post a message to the 'general' category"
11+
12+
- name: "Troubleshooting build issues"
13+
url: "https://github.com/AcademySoftwareFoundation/OpenRV/discussions/categories/build-issues"
14+
about: "Post a message to the 'build-issues' category"

‎.github/PULL_REQUEST_TEMPLATE

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
Thanks for your contribution! Please read this comment in its entirety. It's quite important.
3+
When a contributor merges the pull request, the title and the description will be used to build the merge commit!
4+
5+
### Pull Request TITLE
6+
7+
It should be in the following format:
8+
9+
[ 12345: Summary of the changes made ] Where 12345 is the corresponding Github Issue
10+
11+
OR
12+
13+
[ Summary of the changes made ] If it's solving something trivial, like fixing a typo.
14+
-->
15+
16+
### Linked issues
17+
<!--
18+
Link the Issue(s) this Pull Request is related to.
19+
20+
Each PR should link to at least one issue, in the form:
21+
22+
Use one line for each Issue. This allows auto-closing the related issue when the fix is merged.
23+
24+
Fixes #12345
25+
Fixes #54345
26+
-->
27+
28+
### Summarize your change.
29+
30+
### Describe the reason for the change.
31+
32+
### Describe what you have tested and on which operating system.
33+
34+
### Add a list of changes, and note any that might need special attention during the review.
35+
36+
### If possible, provide screenshots.

‎CODE_OF_CONDUCT.md

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

0 commit comments

Comments
 (0)