-
Notifications
You must be signed in to change notification settings - Fork 0
Improve contributor onboarding and policy docs #47
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| ## Summary | ||
|
|
||
| - | ||
|
|
||
| ## Verification | ||
|
|
||
| - | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] I ran the smallest relevant local check, or explained why I could not. | ||
| - [ ] I added tests or a manual verification note for behavior changes. | ||
| - [ ] I added a changeset for runtime behavior changes, or this PR does not need one. | ||
| - [ ] I updated docs when behavior, commands, or contributor flow changed. | ||
| - [ ] I updated `bun.lock` and `THIRD_PARTY_NOTICES.md` if dependencies changed. | ||
| - [ ] I did not include secrets, credentials, customer data, local machine paths, or generated debug artifacts. | ||
| - [ ] I understand external contributors must sign the CLA when prompted. | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -59,7 +59,7 @@ bun run dev | |||||
| Every behavior-changing PR ships a `.changeset/<kebab-name>.md` file. The body becomes the user-facing entry on the next beta's GitHub Release and on the aggregated stable Release notes — that's how npm consumers and DMG auto-update users learn what changed. Write release-note copy, not a commit-message reprise. | ||||||
|
|
||||||
| - Create one with `bun run changeset`, or hand-write a file named `.changeset/<descriptive-kebab-slug>.md`. | ||||||
| - Front-matter: at minimum `'@inkeep/open-knowledge': patch`. Open Knowledge follows semver with a **pre-1.0 shift-down**: while we're below `1.0.0`, what semver would call a major (breaking API change) is encoded as `minor`, and what semver would call a minor (new feature) is encoded as `patch`. Most changesets are `patch`. `minor` is rare — reserve it for large API contract changes or large feature additions. **Never declare `major` pre-1.0** (see the `"//"` line in `.changeset/config.json`). | ||||||
| - Bump type: use `patch` for bug fixes, UI improvements, and small user-visible additions; use `minor` for breaking API, schema, or CLI changes, and for large new surfaces. **Never declare `major` pre-1.0** (see the `"//"` line in `.changeset/config.json`). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💭 Consider — Dropped frequency heuristic useful for agent decision-making Issue: The rewrite removed the operational heuristic "Most changesets are Why: The mapping rules tell you what each level means; the frequency heuristic tells you which to reach for under uncertainty. Dropping it slightly raises the chance an agent over-classifies a change as Fix: (1-click apply)
Suggested change
Refs:
|
||||||
| - Body should lead with the user-visible verb, name the affected command or surface in a code-span, and (if relevant) show before/after. Skip internal references like spec IDs or story numbers — those rot and aren't visible to readers of the public release notes. | ||||||
| - Don't write inline references to sibling-package versions (e.g. `@inkeep/open-knowledge-core@0.5.0-beta.6`) — the fixed-group lock-step bumps are computed at release time and any number you'd write would be wrong. | ||||||
| - Skip changesets for docs-only edits, test-only edits, or CI-only edits that don't change runtime behavior. | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We want Open Knowledge to be a respectful, practical, and welcoming project for contributors and maintainers. | ||
|
|
||
| ## Expected Behavior | ||
|
|
||
| - Be respectful and constructive. | ||
| - Keep discussions focused on the work. | ||
| - Assume good intent, and ask clarifying questions when something is unclear. | ||
| - Accept maintainer decisions about scope, priority, and project direction. | ||
|
|
||
| ## Unacceptable Behavior | ||
|
|
||
| - Harassment, threats, or personal attacks. | ||
| - Discriminatory language or conduct. | ||
| - Publishing private information without permission. | ||
| - Repeatedly disrupting project discussions after a maintainer asks you to stop. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Maintainers may remove comments, close issues or pull requests, limit participation, or block users when behavior harms the project or its contributors. | ||
|
|
||
| To report a conduct concern, contact an Inkeep maintainer privately when possible. Include relevant links, screenshots, or context. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Security Policy | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| Please do not open a public GitHub issue for a suspected vulnerability. | ||
|
|
||
| Report security issues by emailing incidents@inkeep.com with: | ||
|
|
||
| - A description of the issue and affected component. | ||
| - Steps to reproduce or proof-of-concept details, if available. | ||
| - The impact you believe the issue may have. | ||
| - Any suggested mitigation. | ||
|
|
||
| We will acknowledge reports as soon as practical and coordinate disclosure timelines directly with the reporter. | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| Open Knowledge is pre-1.0. Security fixes are shipped through the latest public release and the public mirror's `main` branch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💭 Consider — "Verification" section purpose is unclear
Issue: The "Verification" section is a bare bullet placeholder (
-) with no guidance on what content it expects. First-time contributors will likely skip it or duplicate their Summary text, since the two sections look identical.Why: The checklist item on line 12 ("I added tests or a manual verification note") implies this is where that note should go — but the section header alone doesn't convey that. A brief HTML comment would make the section self-documenting without adding visual noise.
Fix: (1-click apply)
Refs: