Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Add Open Knowledge issue/PR templates and security policy (#2078)

Andrew Mikofalvy82782e9f4f5e
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..9275293c8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,78 @@
+name: Bug report
+description: Report something that isn't working in Open Knowledge
+title: "[Bug]: "
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to file a bug. Please fill in the fields below so we can reproduce it quickly.
+
+ For setup help or "how do I…" questions, please use [Discord](https://discord.com/invite/YujKpFN49) or the [docs](https://openknowledge.ai) instead — those get faster answers than an issue.
+ - type: checkboxes
+ id: preflight
+ attributes:
+ label: Preflight
+ options:
+ - label: I searched existing issues and this isn't a duplicate
+ required: true
+ - label: I'm on the latest version (or I've noted my version below)
+ required: false
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: A clear description of the bug, including what you expected to happen instead.
+ validations:
+ required: true
+ - type: textarea
+ id: repro
+ attributes:
+ label: Steps to reproduce
+ description: Numbered steps that reliably trigger the bug.
+ placeholder: |
+ 1. Open …
+ 2. Click …
+ 3. See …
+ validations:
+ required: true
+ - type: dropdown
+ id: platform
+ attributes:
+ label: Platform
+ options:
+ - macOS (Apple Silicon)
+ - macOS (Intel)
+ - Windows
+ - Linux
+ - Web app
+ - CLI only
+ validations:
+ required: true
+ - type: dropdown
+ id: install-method
+ attributes:
+ label: How did you install Open Knowledge?
+ options:
+ - Desktop app (DMG)
+ - CLI (npm / npx)
+ - Web app
+ - Built from source
+ validations:
+ required: true
+ - type: input
+ id: version
+ attributes:
+ label: Version
+ description: "Desktop: Help → About. CLI: run with --version."
+ placeholder: "e.g. 0.16.1"
+ validations:
+ required: true
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs, errors, or screenshots
+ description: Paste any console output or attach screenshots. Text is rendered as code.
+ render: shell
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..00d8c91aa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Questions & community help
+ url: https://discord.com/invite/YujKpFN49
+ about: Setup help, "how do I…" questions, and general discussion. Please ask here rather than opening an issue.
+ - name: Documentation
+ url: https://openknowledge.ai
+ about: Guides, CLI reference, MCP, and editor integrations.
+ - name: Report a security vulnerability
+ url: https://github.com/inkeep/open-knowledge/security/advisories/new
+ about: Report security issues privately via GitHub's security advisories, never as a public issue.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..8d5aa03b9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,42 @@
+name: Feature request
+description: Suggest an idea or improvement
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for the suggestion! If this is an open-ended idea worth discussing, [Discord](https://discord.com/invite/YujKpFN49) is often a better starting place.
+ - type: textarea
+ id: problem
+ attributes:
+ label: What problem are you trying to solve?
+ description: Describe the use case or pain point, not just the proposed solution.
+ validations:
+ required: true
+ - type: textarea
+ id: proposal
+ attributes:
+ label: Proposed solution
+ validations:
+ required: false
+ - type: dropdown
+ id: area
+ attributes:
+ label: Area
+ options:
+ - Editor
+ - GitHub sync
+ - CLI
+ - MCP / agent integration
+ - Desktop app
+ - Docs
+ - Other
+ validations:
+ required: false
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternatives considered
+ validations:
+ required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..32877edaa
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,26 @@
+## What & why
+
+<!-- One or two sentences on the change and the motivation. Link any related issue. -->
+
+## How this was verified
+
+<!-- How you tested: `bun run check` output, manual steps, before/after screenshots for UI changes. -->
+
+## Checklist
+
+- [ ] Ran `bun run check` (lint, typecheck, tests) locally
+- [ ] Added a changeset (`bun run changeset`) if this changes behavior
+- [ ] Updated docs if this changes a user-facing surface
+- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md) and agree to license my contribution under the project's terms (CLA)
+
+---
+
+### How our PR flow works — please read
+
+This repository is **mirrored from an internal monorepo**. After you open this PR:
+
+1. A bot mirrors your changes internally for review (it posts a link you won't be able to open — that's expected).
+2. Maintainer review and full CI (lint, typecheck, tests) happen internally; results are **not** posted back to this PR.
+3. Once the change lands internally and syncs back, **your PR is closed — not merged.** Your authorship is preserved.
+
+If you don't hear back within a few business days, commenting to nudge is welcome. See [CONTRIBUTING.md](../CONTRIBUTING.md) for the full flow.
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
new file mode 100644
index 000000000..2af691c9c
--- /dev/null
+++ b/.github/SECURITY.md
@@ -0,0 +1,21 @@
+# Security Policy
+
+Open Knowledge is a local-first desktop and CLI application that reads and writes files on your machine, stores credentials in your OS keyring, and can sync with GitHub. We take security reports seriously and appreciate responsible disclosure.
+
+## Reporting a vulnerability
+
+**Please do not open a public issue for security vulnerabilities.**
+
+Report privately through GitHub's [Private Vulnerability Reporting](https://github.com/inkeep/open-knowledge/security/advisories/new) — the "Report a vulnerability" button on the repository's **Security** tab. This opens a confidential channel with the maintainers.
+
+We aim to acknowledge new reports within 3 business days and will keep you updated on remediation. Please give us a reasonable window to ship a fix before any public disclosure.
+
+## Supported versions
+
+Open Knowledge is pre-1.0 and ships frequent releases. Only the **latest stable release** receives security fixes. Please reproduce on the latest version before reporting.
+
+## Scope
+
+**In scope:** the desktop app, local server, CLI, GitHub-sync credential handling, and the MCP server in this repository.
+
+**Out of scope:** the marketing website, vulnerabilities in third-party dependencies (please report those upstream), and findings that require physical access to an already-compromised machine or social engineering.