Skip to content

Commit 3ce8ec9

Browse files
committed
chore: add initial project governance files including Code of Conduct, Security Policy, and issue templates for better community engagement and support
1 parent f8304cc commit 3ce8ec9

File tree

10 files changed

+954
-7
lines changed

10 files changed

+954
-7
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
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.
30+
31+
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.
32+
33+
## Scope
34+
35+
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.
36+
37+
## Enforcement
38+
39+
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.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**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.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**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.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**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.
64+
65+
### 4. Permanent Ban
66+
67+
**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.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: '[Bug]: '
4+
labels: ['bug', 'needs-triage']
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible to help us reproduce and fix the issue.
12+
13+
- type: textarea
14+
id: bug-description
15+
attributes:
16+
label: Bug Description
17+
description: A clear and concise description of what the bug is.
18+
placeholder: Describe the bug...
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: steps-to-reproduce
24+
attributes:
25+
label: Steps to Reproduce
26+
description: Steps to reproduce the behavior
27+
placeholder: |
28+
1. Go to '...'
29+
2. Click on '....'
30+
3. Scroll down to '....'
31+
4. See error
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: expected-behavior
37+
attributes:
38+
label: Expected Behavior
39+
description: A clear and concise description of what you expected to happen.
40+
placeholder: What should have happened?
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: actual-behavior
46+
attributes:
47+
label: Actual Behavior
48+
description: A clear and concise description of what actually happened.
49+
placeholder: What actually happened?
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: screenshots
55+
attributes:
56+
label: Screenshots
57+
description: If applicable, add screenshots to help explain your problem.
58+
placeholder: Drag and drop screenshots here...
59+
60+
- type: dropdown
61+
id: environment
62+
attributes:
63+
label: Environment
64+
description: Select your environment
65+
options:
66+
- Development
67+
- Production
68+
- Staging
69+
- Local
70+
validations:
71+
required: true
72+
73+
- type: input
74+
id: os
75+
attributes:
76+
label: Operating System
77+
description: What operating system are you using?
78+
placeholder: e.g., macOS 14.0, Windows 11, Ubuntu 22.04
79+
validations:
80+
required: true
81+
82+
- type: input
83+
id: node-version
84+
attributes:
85+
label: Node.js Version
86+
description: What version of Node.js are you using?
87+
placeholder: e.g., 18.17.0
88+
validations:
89+
required: true
90+
91+
- type: input
92+
id: pnpm-version
93+
attributes:
94+
label: pnpm Version
95+
description: What version of pnpm are you using?
96+
placeholder: e.g., 8.10.0
97+
validations:
98+
required: true
99+
100+
- type: input
101+
id: browser
102+
attributes:
103+
label: Browser (if applicable)
104+
description: What browser are you using?
105+
placeholder: e.g., Chrome 119, Firefox 119, Safari 17
106+
validations:
107+
required: false
108+
109+
- type: textarea
110+
id: error-logs
111+
attributes:
112+
label: Error Logs
113+
description: If applicable, paste any error logs or console output.
114+
placeholder: Paste error logs here...
115+
render: shell
116+
117+
- type: textarea
118+
id: additional-context
119+
attributes:
120+
label: Additional Context
121+
description: Add any other context about the problem here.
122+
placeholder: Any additional information that might be helpful...
123+
124+
- type: checkboxes
125+
id: checklist
126+
attributes:
127+
label: Checklist
128+
description: Please confirm the following
129+
options:
130+
- label: I have searched existing issues to ensure this is not a duplicate
131+
required: true
132+
- label: I have provided all the information requested above
133+
required: true
134+
- label: I am using the latest version of the project
135+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 GitHub Discussions
4+
url: https://github.com/alloylab/overland/discussions
5+
about: Ask questions, share ideas, and discuss the project with the community
6+
- name: 📖 Documentation
7+
url: https://github.com/alloylab/overland#readme
8+
about: Check our comprehensive documentation and setup guides
9+
- name: 🐛 Bug Report
10+
url: https://github.com/alloylab/overland/issues/new?template=bug_report.yml
11+
about: Report a bug or unexpected behavior
12+
- name: ✨ Feature Request
13+
url: https://github.com/alloylab/overland/issues/new?template=feature_request.yml
14+
about: Suggest a new feature or enhancement
15+
- name: 📚 Documentation Issue
16+
url: https://github.com/alloylab/overland/issues/new?template=documentation.yml
17+
about: Report missing, unclear, or incorrect documentation
18+
- name: 🔒 Security Vulnerability
19+
url: https://github.com/alloylab/overland/issues/new?template=security.yml
20+
about: Report a security vulnerability (please email [email protected] instead)
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: 📚 Documentation
2+
description: Report missing, unclear, or incorrect documentation
3+
title: '[Docs]: '
4+
labels: ['documentation', 'needs-triage']
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for helping improve our documentation! Please provide details about what documentation needs to be updated.
12+
13+
- type: dropdown
14+
id: doc-type
15+
attributes:
16+
label: Documentation Type
17+
description: What type of documentation issue is this?
18+
options:
19+
- README
20+
- CONTRIBUTING.md
21+
- SECURITY.md
22+
- API Documentation
23+
- Code Comments
24+
- Setup Instructions
25+
- Deployment Guide
26+
- Other
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: issue-description
32+
attributes:
33+
label: Issue Description
34+
description: Describe the documentation problem.
35+
placeholder: What's wrong with the documentation?
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: current-docs
41+
attributes:
42+
label: Current Documentation
43+
description: What does the current documentation say? (if applicable)
44+
placeholder: Quote or describe the current documentation...
45+
46+
- type: textarea
47+
id: expected-docs
48+
attributes:
49+
label: Expected Documentation
50+
description: What should the documentation say instead?
51+
placeholder: Describe what the documentation should say...
52+
53+
- type: input
54+
id: file-location
55+
attributes:
56+
label: File Location
57+
description: Which file(s) need to be updated?
58+
placeholder: e.g., README.md, CONTRIBUTING.md, apps/web/README.md
59+
validations:
60+
required: true
61+
62+
- type: dropdown
63+
id: priority
64+
attributes:
65+
label: Priority
66+
description: How important is this documentation fix?
67+
options:
68+
- Low - Minor clarification
69+
- Medium - Important for understanding
70+
- High - Blocking users from getting started
71+
- Critical - Incorrect information that could cause problems
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: additional-context
77+
attributes:
78+
label: Additional Context
79+
description: Add any other context about the documentation issue here.
80+
placeholder: Any additional information that might be helpful...
81+
82+
- type: checkboxes
83+
id: checklist
84+
attributes:
85+
label: Checklist
86+
description: Please confirm the following
87+
options:
88+
- label: I have searched existing issues to ensure this is not a duplicate
89+
required: true
90+
- label: I have provided all the information requested above
91+
required: true
92+
- label: I am willing to help improve the documentation if needed
93+
required: false

0 commit comments

Comments
 (0)