Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
Make Open Knowledge's contribution text warmer (#7701)
Nick Gomez615219384cfd
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.ymlindex a48ca3195..94b115094 100644--- a/.github/ISSUE_TEMPLATE/bug_report.yml+++ b/.github/ISSUE_TEMPLATE/bug_report.yml@@ -6,7 +6,7 @@ body:- type: markdownattributes:value: |- Thanks for taking the time to file a bug. Please fill in the fields below so we can reproduce it quickly.+ Thanks for taking the time to file a bug. The reports we can fix fastest say what happens and when, and give the fewest steps that show it. One problem per issue, please. For a security problem, please [report it privately](https://github.com/inkeep/open-knowledge/security/advisories/new) instead of opening a public issue.For setup help or "how do I…" questions, please use [Discord](https://discord.gg/VRKk2EaGHN) or the [docs](https://openknowledge.ai) instead — those get faster answers than an issue.- type: checkboxes@@ -22,20 +22,44 @@ body:id: what-happenedattributes:label: What happened?- description: A clear description of the bug, including what you expected to happen instead.+ description: What you did, what you expected, and what you saw instead. A screenshot helps for visual problems.validations:required: true- type: textareaid: reproattributes:label: Steps to reproduce- description: Numbered steps that reliably trigger the bug.+ description: The fewest steps that still show the bug, ideally starting from a new project.placeholder: |1. Open …2. Click …3. See …validations:required: true+ - type: dropdown+ id: frequency+ attributes:+ label: How often does it happen?+ options:+ - Every time+ - Sometimes+ - Only once so far+ validations:+ required: false+ - type: input+ id: last-working-version+ attributes:+ label: Did it work in an earlier version?+ description: If it used to work, the last version where it did.+ validations:+ required: false+ - type: textarea+ id: tried+ attributes:+ label: What have you already tried?+ description: Workarounds or checks you have already done, and what they showed.+ validations:+ required: false- type: dropdownid: platformattributes:@@ -71,15 +95,15 @@ body:- type: textareaid: code-pointersattributes:- label: Relevant code- description: Files, functions or links to lines you think are involved, with the fix described in words. Please don't paste a full patch or open a pull request.+ label: Anything else?+ description: Anything else that might help, such as code you suspect, related issues, or your own ideas. Optional.validations:required: false- type: textareaid: logsattributes:- label: Logs, errors, or screenshots- description: Paste any console output or attach screenshots. Text is rendered as code.+ label: Error text and logs+ description: The full error message and any log output, pasted as text.render: shellvalidations:required: falsediff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.ymlindex 1ba4996fd..7c551c149 100644--- a/.github/ISSUE_TEMPLATE/feature_request.yml+++ b/.github/ISSUE_TEMPLATE/feature_request.yml@@ -11,13 +11,21 @@ body:id: problemattributes:label: What problem are you trying to solve?- description: Describe the use case or pain point, not just the proposed solution.+ description: "The situation you are in and what you are trying to get done, rather than the feature you have in mind. For example: when I …, I want to …, so that …"validations:required: true+ - type: textarea+ id: today+ attributes:+ label: How do you handle this today?+ description: What you do instead now, and what makes it hard.+ validations:+ required: false- type: textareaid: proposalattributes:label: Proposed solution+ description: Optional. Any ideas for how it could work.validations:required: false- type: textarea@@ -30,8 +38,8 @@ body:- type: textareaid: code-pointersattributes:- label: Relevant code- description: Files, functions or links to lines you think are involved, with the change described in words. Please don't paste a full patch or open a pull request.+ label: Anything else?+ description: Anything else that might help, such as related issues or code you suspect. Optional.validations:required: false- type: dropdown@@ -52,5 +60,6 @@ body:id: alternativesattributes:label: Alternatives considered+ description: Other tools or approaches you looked at, and why they did not work for you.validations:required: falsediff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.mdindex e290c0b14..fbebf73ae 100644--- a/.github/PULL_REQUEST_TEMPLATE.md+++ b/.github/PULL_REQUEST_TEMPLATE.md@@ -1,7 +1,5 @@-# Please file an issue instead+# Thanks for wanting to contribute!-We do not accept pull requests, including small fixes and translation changes.+We build changes ourselves from issues, so we do not merge pull requests here, even small fixes or translation corrections.-Please [file a detailed issue](https://github.com/inkeep/open-knowledge/issues/new/choose) describing the problem, steps to reproduce it, or the outcome you want. See [Write an issue we can build from](https://github.com/inkeep/open-knowledge/blob/main/CONTRIBUTING.md#write-an-issue-we-can-build-from).--Filing an issue does not commit the maintainers to building the change.+The most helpful next step is a [detailed issue](https://github.com/inkeep/open-knowledge/issues/new/choose): what you found and how to reproduce it, or what you are trying to do. [Write an issue we can build from](https://github.com/inkeep/open-knowledge/blob/main/CONTRIBUTING.md#write-an-issue-we-can-build-from) has a few tips.diff --git a/CLA.md b/CLA.mdindex 99185dff0..f6996e6d3 100644--- a/CLA.md+++ b/CLA.md@@ -1,4 +1,4 @@-> Historical agreement for earlier code contributions. OpenKnowledge no longer accepts pull requests; please [file a detailed issue](./CONTRIBUTING.md#write-an-issue-we-can-build-from). This agreement is retained as a record, and no signature is requested for issues.+> This agreement covers earlier code contributions and is kept as a record. Contributions now come in as [detailed issues](./CONTRIBUTING.md#write-an-issue-we-can-build-from), which need no signature.> Based on the Apache Individual Contributor License Agreement (ICLA) V2.2, with Inkeep, Inc. as the grantee. It is a copyright and patent **license**, not an assignment, so you keep full ownership of your contributions. The license-grant and representation clauses (sections 1 to 8) are the verbatim Apache text; the Foundation's nonprofit-specific covenant and the paper contact-form fields are omitted.diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 335020c5e..0db1711b6 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -1,8 +1,8 @@# Contributing to OpenKnowledge-Thanks for helping. We do not accept pull requests. Please [file a detailed issue](https://github.com/inkeep/open-knowledge/issues/new/choose) so we can understand the problem and consider it for our work.+Thanks for helping make OpenKnowledge better! The best way to contribute is a [detailed issue](https://github.com/inkeep/open-knowledge/issues/new/choose): tell us what you ran into or what you would like to do, and we will take it from there.-- **Found a bug or have an idea?** [Open an issue](https://github.com/inkeep/open-knowledge/issues/new/choose). This is the main way to contribute; see [Write an issue we can build from](#write-an-issue-we-can-build-from).+- **Found a bug or have an idea?** [Open an issue](https://github.com/inkeep/open-knowledge/issues/new/choose), and see [Write an issue we can build from](#write-an-issue-we-can-build-from) for what helps.- **Question or setup help?** Ask in [Discord](https://discord.gg/VRKk2EaGHN).- **Read a language other than English?** Most of our interface translations are machine-translated and have never been read by a native speaker, and we ship them anyway rather than hide them from the people who could fix them. Correcting one is the most useful thing you can do for it — see [Translate the interface](https://openknowledge.ai/docs/contribute/translations).@@ -15,12 +15,12 @@ Reviewing an outside pull request takes us longer than building the same changeUse the bug report or feature request form. The issues we can act on fastest:- **Start with the problem, not the solution.** Say what you were doing, what happened, and why it matters to you.-- **For a bug,** give steps that reproduce it, your version and platform, and any logs or screenshots.-- **For a feature,** describe what you would see if it worked. That tells us when it is done.-- **Point at the code if you found it.** A file, a function or a link to a line helps.-- **Describe a proposed fix in words.** Please do not paste a full patch or open a pull request.+- **For a bug,** tell us what you did, what you expected and what you saw instead. Then add the fewest steps that show it, ideally in a new project; how often it happens; whether it worked in an earlier version; your version, platform and install method; and the full error text or logs, pasted as text.+- **For a feature,** describe the situation you are in and what you are trying to get done, how you handle it today, and what you would see if it worked.+- **One problem per issue.** Separate problems are easier to track and fix.+- **Anything else that helps is welcome,** such as code you suspect or your own ideas. None of it is required.-Filing an issue does not commit us to building the change. When a fix ships, we close your issue, and our release automation usually comments on it with the version the fix shipped in.+We read every issue. We cannot promise to build every request, but a clear issue gives it the best chance. When a fix ships, we close your issue, and our release automation usually comments on it with the version it shipped in.## How credit works@@ -100,7 +100,7 @@ If lint stops you, the diagnostic names the class of comment, the fix, and links## Pull requests-We do not accept pull requests, including small fixes and translation changes. Please use the [issue forms](https://github.com/inkeep/open-knowledge/issues/new/choose) and the guidance above instead.+We build every change ourselves from issues, small fixes and translation corrections included, so we do not merge outside pull requests. If you have spotted something, the most helpful thing you can do is [open an issue](https://github.com/inkeep/open-knowledge/issues/new/choose) describing it.## Licensediff --git a/README.md b/README.mdindex 492ecb067..013260e13 100644--- a/README.md+++ b/README.md@@ -76,9 +76,7 @@ Docs for general usage: <https://openknowledge.ai/docs>.## Contributions-We do not accept pull requests. Please file a detailed [issue](https://github.com/inkeep/open-knowledge/issues/new/choose) with the problem, steps to reproduce it or the outcome you want. We use issues to consider and track changes.--See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.+The best way to contribute is a detailed [issue](https://github.com/inkeep/open-knowledge/issues/new/choose): the problem you hit and how to reproduce it, or what you are trying to do. We build changes from issues rather than pull requests. [CONTRIBUTING.md](CONTRIBUTING.md) has tips on writing one we can act on quickly.## Licensediff --git a/docs/content/contribute/translations.mdx b/docs/content/contribute/translations.mdxindex c9059fc2a..2ac6a02bd 100644--- a/docs/content/contribute/translations.mdx+++ b/docs/content/contribute/translations.mdx@@ -44,7 +44,7 @@ Put your suggested wording and why it is clearer in **Proposed solution**.If you found the entry in `packages/app/src/locales/<locale>/messages.po`, include its `msgid` so we can locate it. The [glossary](https://github.com/inkeep/open-knowledge/blob/main/packages/app/src/locales/GLOSSARY.md) lists the words we use consistently; mention any glossary wording that needs correcting too.-We do not accept pull requests for translations. See [CONTRIBUTING.md](https://github.com/inkeep/open-knowledge/blob/main/CONTRIBUTING.md) for issue guidance.+We make translation changes ourselves from these reports rather than from pull requests, so an issue is the way to send a correction. [CONTRIBUTING.md](https://github.com/inkeep/open-knowledge/blob/main/CONTRIBUTING.md) has more tips on writing one.## What is and isn't translated@@ -56,4 +56,4 @@ We do not accept pull requests for translations. See [CONTRIBUTING.md](https://g## A language that isn't on the list-Choose **Feature request** in the [issue chooser](https://github.com/inkeep/open-knowledge/issues/new/choose), name the language and describe who would benefit. Filing an issue does not commit the maintainers to adding it.+Choose **Feature request** in the [issue chooser](https://github.com/inkeep/open-knowledge/issues/new/choose), name the language and describe who would benefit. We read every request, though we cannot promise to add every language.