Skip to content

Commit 3fa4d59

Browse files
docs: add OSS community health files
- CONTRIBUTING.md: contributor onboarding, conventional commit rules, local setup - CODE_OF_CONDUCT.md: adopts Contributor Covenant 2.1 by reference - SECURITY.md: vulnerability reporting via GitHub private advisories, scope boundaries - .github/ISSUE_TEMPLATE/config.yml: disables blank issues, links to discussions and Honcho upstream Lifts the GitHub community profile score from 57% toward 100%.
1 parent 2349a1d commit 3fa4d59

4 files changed

Lines changed: 120 additions & 0 deletions

File tree

.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: Honcho upstream issues
4+
url: https://github.com/plastic-labs/honcho/issues
5+
about: Bugs in the Honcho server itself, not the OpenConcho UI.
6+
- name: Question or discussion
7+
url: https://github.com/offendingcommit/openconcho/discussions
8+
about: General questions, ideas, or design discussion.

CODE_OF_CONDUCT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Code of Conduct
2+
3+
This project adopts the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) as its code of conduct.
4+
5+
The full text is available at the link above.
6+
7+
## Reporting
8+
9+
Report violations to the maintainer at the email address listed on the [GitHub profile of @offendingcommit](https://github.com/offendingcommit). All reports are reviewed and investigated promptly and fairly.
10+
11+
## Scope
12+
13+
This Code of Conduct applies within all project spaces — issues, pull requests, discussions, and any other public or private channel where you represent the project.

CONTRIBUTING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing to OpenConcho
2+
3+
Thanks for your interest in helping out. This is a small, focused project — please read this before opening a PR.
4+
5+
## Ground rules
6+
7+
- **Open an issue first** for anything beyond a small fix. Discussion saves wasted work.
8+
- **Conventional commits** are required (`feat:`, `fix:`, `docs:`, `refactor:`, `test:`, `chore:`). They drive [semantic-release](https://semantic-release.gitbook.io/).
9+
- **One logical change per PR.** Easier to review, easier to revert.
10+
11+
## Local setup
12+
13+
```bash
14+
git clone https://github.com/offendingcommit/openconcho.git
15+
cd openconcho
16+
pnpm install
17+
pnpm dev # web dev server at http://localhost:5173
18+
```
19+
20+
For desktop work:
21+
22+
```bash
23+
pnpm --filter @openconcho/desktop dev
24+
```
25+
26+
## Before opening a PR
27+
28+
```bash
29+
pnpm lint # Biome lint
30+
pnpm typecheck # tsc --noEmit
31+
pnpm test # Vitest
32+
pnpm build # full build
33+
```
34+
35+
All four must pass. CI will block the merge otherwise.
36+
37+
## Coding standards
38+
39+
The full standards live in [`.claude/rules/coding-standards.md`](.claude/rules/coding-standards.md). The short version:
40+
41+
- TypeScript strict mode; no `any`.
42+
- No hardcoded URLs — connection config lives in `localStorage` under `openconcho:config`.
43+
- Use CSS variables (`var(--text-1)`) for theme-aware colors, never Tailwind color utilities.
44+
- Cast TanStack Router `params` as `as never` at navigation callsites.
45+
- One assertion per test.
46+
47+
## API schema changes
48+
49+
`src/api/schema.d.ts` is generated. Don't edit it by hand — run:
50+
51+
```bash
52+
pnpm generate:api
53+
```
54+
55+
…after updating `openapi.json`.
56+
57+
## Reporting bugs
58+
59+
Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.yml). Include the Honcho version, your OS, and reproduction steps.
60+
61+
## License
62+
63+
By contributing, you agree your contributions are licensed under the [MIT License](LICENSE).

SECURITY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
OpenConcho follows semantic versioning via [semantic-release](https://semantic-release.gitbook.io/). Only the latest minor release on `main` receives security fixes.
6+
7+
| Version | Supported |
8+
|---------|-----------|
9+
| latest ||
10+
| older ||
11+
12+
## Reporting a Vulnerability
13+
14+
**Please do not open public issues for security reports.**
15+
16+
Use GitHub's [private vulnerability reporting](https://github.com/offendingcommit/openconcho/security/advisories/new) to file a report. Include:
17+
18+
- A description of the issue and its impact
19+
- Steps to reproduce
20+
- Affected version(s)
21+
- Any mitigations you've identified
22+
23+
You should expect an acknowledgement within 72 hours and a fix or status update within 14 days.
24+
25+
## Scope
26+
27+
OpenConcho is a frontend client. It stores connection config (`base URL`, optional `token`) in `localStorage` under the keys `openconcho:config` and `openconcho:theme`. It makes no network requests outside the Honcho instance you configure.
28+
29+
In-scope:
30+
- XSS, CSRF, or other client-side vulnerabilities in the OpenConcho UI
31+
- Token leakage from `localStorage` to third parties
32+
- Build-toolchain supply-chain issues
33+
34+
Out of scope:
35+
- Vulnerabilities in your own Honcho instance — report those upstream at [plastic-labs/honcho](https://github.com/plastic-labs/honcho)
36+
- Issues that require physical access to an unlocked device

0 commit comments

Comments
 (0)