Skip to content

Commit 5d49737

Browse files
CalvinAllenCalvinAllen
authored
docs: add community templates and guidelines (#25)
- Add CONTRIBUTING.md with development setup and guidelines - Add CODE_OF_CONDUCT.md (Contributor Covenant with People FIRST emphasis) - Add GitHub issue templates (bug report, feature request) - Add pull request template
1 parent 2f00d8c commit 5d49737

5 files changed

Lines changed: 433 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "fix: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of the bug.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
placeholder: Describe what you expected...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual Behavior
45+
description: What actually happened?
46+
placeholder: Describe what actually happened...
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: os
52+
attributes:
53+
label: Windows Version
54+
description: Which version of Windows are you using?
55+
placeholder: "e.g., Windows 11 23H2"
56+
validations:
57+
required: true
58+
59+
- type: input
60+
id: vs-versions
61+
attributes:
62+
label: Visual Studio Versions
63+
description: Which Visual Studio versions are installed?
64+
placeholder: "e.g., VS 2022 17.8, VS 2019 16.11"
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: additional
70+
attributes:
71+
label: Additional Context
72+
description: Add any other context, screenshots, or logs about the problem.
73+
placeholder: Any additional information...
74+
validations:
75+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "feat: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please fill out the form below.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: "I'm always frustrated when..."
17+
validations:
18+
required: false
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like.
25+
placeholder: Describe your proposed feature...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered.
34+
placeholder: Other approaches you've thought about...
35+
validations:
36+
required: false
37+
38+
- type: textarea
39+
id: additional
40+
attributes:
41+
label: Additional Context
42+
description: Add any other context, mockups, or screenshots about the feature request.
43+
placeholder: Any additional information...
44+
validations:
45+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Description
2+
3+
<!-- Briefly describe the changes in this PR -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an "x" -->
8+
9+
- [ ] `feat` - New feature
10+
- [ ] `fix` - Bug fix
11+
- [ ] `docs` - Documentation only
12+
- [ ] `refactor` - Code change that neither fixes a bug nor adds a feature
13+
- [ ] `test` - Adding or updating tests
14+
- [ ] `chore` - Maintenance tasks
15+
- [ ] `ci` - CI/CD changes
16+
17+
## Related Issues
18+
19+
<!-- Link any related issues using "Closes #123" or "Fixes #123" -->
20+
21+
## Checklist
22+
23+
- [ ] My code follows the project's code style
24+
- [ ] I have tested my changes locally
25+
- [ ] I have updated documentation if needed
26+
- [ ] My commits follow the conventional commit format
27+
- [ ] This PR has a descriptive title using conventional commit format
28+
29+
## Screenshots (if applicable)
30+
31+
<!-- Add screenshots to help explain your changes -->
32+
33+
## Additional Notes
34+
35+
<!-- Any additional information reviewers should know -->

‎CODE_OF_CONDUCT.md‎

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

0 commit comments

Comments
 (0)