Skip to content

Commit 5c08eac

Browse files
cj-vanaclaude
andcommitted
chore: Add GitHub repository configuration
- Add issue templates (bug report, feature request) - Add pull request template - Add CI workflow (lint, typecheck, build) - Add security scanning workflow (npm audit) - Add CODE_OF_CONDUCT.md (Contributor Covenant) - Add CONTRIBUTING.md (contribution guidelines) - Add LICENSE (MIT) - Add SECURITY.md (vulnerability reporting policy) - Update GitHub links to Denver-MeshCore organization 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent e311429 commit 5c08eac

File tree

11 files changed

+516
-1
lines changed

11 files changed

+516
-1
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
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 what the bug is.
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. Scroll down to '...'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected
35+
attributes:
36+
label: Expected Behavior
37+
description: What did you expect to happen?
38+
placeholder: Describe what you expected...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual Behavior
46+
description: What actually happened?
47+
placeholder: Describe what actually happened...
48+
validations:
49+
required: true
50+
51+
- type: dropdown
52+
id: browser
53+
attributes:
54+
label: Browser
55+
description: Which browser are you using?
56+
options:
57+
- Chrome
58+
- Firefox
59+
- Safari
60+
- Edge
61+
- Other
62+
validations:
63+
required: false
64+
65+
- type: textarea
66+
id: additional
67+
attributes:
68+
label: Additional Context
69+
description: Add any other context, screenshots, or error messages.
70+
placeholder: Any additional information...
71+
validations:
72+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord Community
4+
url: https://discord.gg/XRyNqs55sN
5+
about: Join our Discord server for questions and community discussions
6+
- name: MeshCore Documentation
7+
url: https://meshcore.co.uk/
8+
about: Check the official MeshCore documentation
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
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? Describe it.
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 to see.
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: Have you considered any alternative solutions or features?
34+
placeholder: Describe alternatives you've considered...
35+
validations:
36+
required: false
37+
38+
- type: dropdown
39+
id: priority
40+
attributes:
41+
label: Priority
42+
description: How important is this feature to you?
43+
options:
44+
- Nice to have
45+
- Important
46+
- Critical
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: additional
52+
attributes:
53+
label: Additional Context
54+
description: Add any other context, mockups, or examples.
55+
placeholder: Any additional information...
56+
validations:
57+
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+
<!-- Describe your changes in detail -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an "x" -->
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Refactoring (no functional changes)
14+
15+
## Related Issues
16+
17+
<!-- Link any related issues here using #issue-number -->
18+
19+
Closes #
20+
21+
## Checklist
22+
23+
- [ ] My code follows the project's code style
24+
- [ ] I have run `npm run lint` and fixed any issues
25+
- [ ] I have run `npx tsc --noEmit` and fixed any type errors
26+
- [ ] I have tested my changes locally
27+
- [ ] I have updated documentation if needed
28+
29+
## Screenshots (if applicable)
30+
31+
<!-- Add screenshots to help explain your changes -->
32+
33+
## Additional Notes
34+
35+
<!-- Any additional information for reviewers -->

.github/workflows/ci.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
lint-and-build:
11+
name: Lint, Type Check & Build
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Node.js
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: '20'
22+
cache: 'npm'
23+
24+
- name: Install dependencies
25+
run: npm ci
26+
27+
- name: Run ESLint
28+
run: npm run lint
29+
30+
- name: Type check
31+
run: npx tsc --noEmit
32+
33+
- name: Build
34+
run: npm run build

.github/workflows/security.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Security Scan
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
schedule:
9+
# Run weekly on Mondays at 9am UTC
10+
- cron: '0 9 * * 1'
11+
12+
jobs:
13+
audit:
14+
name: npm audit
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v4
20+
21+
- name: Setup Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: '20'
25+
cache: 'npm'
26+
27+
- name: Install dependencies
28+
run: npm ci
29+
30+
- name: Run npm audit
31+
run: npm audit --audit-level=high
32+
continue-on-error: false

CODE_OF_CONDUCT.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders of the Denver MeshCore community pledge to make participation in our project and 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, caste, color, 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 focused on building and improving decentralized mesh networking technology.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community and mesh network
18+
* Sharing knowledge and helping others learn about mesh networking technology
19+
* Maintaining the spirit of collaboration and decentralization that mesh networks represent
20+
21+
Examples of unacceptable behavior include:
22+
23+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
24+
* Trolling, insulting or derogatory comments, and personal or political attacks
25+
* Public or private harassment
26+
* Publishing others' private information, such as a physical or email address, without their explicit permission
27+
* Sharing node locations or network topology information without consent
28+
* Disrupting or degrading mesh network operations or intentionally interfering with nodes
29+
* Other conduct which could reasonably be considered inappropriate in a professional setting
30+
31+
## Enforcement Responsibilities
32+
33+
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.
34+
35+
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.
36+
37+
## Scope
38+
39+
This Code of Conduct applies within all community spaces, including but not limited to:
40+
41+
* GitHub repositories and discussions
42+
* Discord server and channels
43+
* Mesh network operations and node interactions
44+
* Community events and meetups
45+
* Any other forums or spaces where community members represent the Denver MeshCore project
46+
47+
This Code of Conduct 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.
48+
49+
## Enforcement
50+
51+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at:
52+
53+
* **Discord**: [discord.gg/QpaW8FTTCE](https://discord.gg/QpaW8FTTCE) (contact moderators)
54+
* **Email**: [Contact through GitHub Issues](https://github.com/Denver-MeshCore/denvermc/issues)
55+
56+
All complaints will be reviewed and investigated promptly and fairly.
57+
58+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
59+
60+
## Enforcement Guidelines
61+
62+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
63+
64+
### 1. Correction
65+
66+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
67+
68+
**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.
69+
70+
### 2. Warning
71+
72+
**Community Impact**: A violation through a single incident or series of actions.
73+
74+
**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.
75+
76+
### 3. Temporary Ban
77+
78+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
79+
80+
**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.
81+
82+
### 4. Permanent Ban
83+
84+
**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.
85+
86+
**Consequence**: A permanent ban from any sort of public interaction within the community.
87+
88+
## Mesh Network Specific Guidelines
89+
90+
Given the nature of our mesh networking project, we also emphasize:
91+
92+
* **Respect for Network Resources**: Do not abuse or intentionally degrade the mesh network infrastructure
93+
* **Responsible Disclosure**: Report security vulnerabilities privately before public disclosure
94+
* **Data Privacy**: Respect the privacy of network users and node operators
95+
* **Geographic Sensitivity**: Be mindful when sharing specific node locations or network topology data
96+
* **Collaborative Spirit**: Embrace the decentralized, community-driven ethos of mesh networking
97+
98+
## Attribution
99+
100+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
101+
102+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
103+
104+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

0 commit comments

Comments
 (0)