chore: update issue templates and docs (#1032)
* chore: update issue templates and docs * chore: slim bug/quality forms and add integration template Drop high-friction required fields from bug and quality issue forms. Add an integration-request form (app stores, plugins, frameworks) labeled integration, and point contributing docs at it. * chore: route security mail to support@ and polish docs intake Use support@honcho.dev for private vulnerability email. List the documentation template in contributing guides, rename Media prove, and add public-issue redaction/security redirects on the docs form. * fix: address render issue in templates and add version field --------- Co-authored-by: Vineeth Voruganti <13438633+VVoruganti@users.noreply.github.com>
This commit is contained in:
Aakash Kattelu
GitHub
parent
c73f6a0b7a
commit
da4b3ee435
|
|
@ -1,76 +0,0 @@
|
|||
---
|
||||
name: "🐞 Bug Report"
|
||||
about: "Report an issue to help the project improve."
|
||||
title: "[Bug] "
|
||||
labels: "bug"
|
||||
assignees: ""
|
||||
|
||||
---
|
||||
|
||||
# **🐞 Bug Report**
|
||||
|
||||
## **Describe the bug**
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
### **Is this a regression?**
|
||||
<!-- Did this behaviour used to work in the previous version? -->
|
||||
<!-- Yes, the last version in which this bug was not present was: ... -->
|
||||
|
||||
---
|
||||
|
||||
### **To Reproduce**
|
||||
|
||||
<!-- Steps to reproduce the error:
|
||||
(e.g.:)
|
||||
1. Use x argument / navigate to
|
||||
2. Fill this information
|
||||
3. Go to...
|
||||
4. See error -->
|
||||
|
||||
<!-- Write the steps here (add or remove as many steps as needed)-->
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
4.
|
||||
|
||||
---
|
||||
|
||||
### **Expected behaviour**
|
||||
<!-- A clear and concise description of what you expected to happen. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
### **Media prove**
|
||||
<!-- If applicable, add screenshots or videos to help explain your problem. -->
|
||||
|
||||
---
|
||||
|
||||
### **Your environment**
|
||||
|
||||
<!-- use all the applicable bulleted list elements for this specific issue,
|
||||
and remove all the bulleted list elements that are not relevant for this issue. -->
|
||||
|
||||
* OS: <!--[e.g. Ubuntu 5.4.0-26-generic x86_64 / Windows 1904 ...]-->
|
||||
* Browser name and version:
|
||||
* Honcho Server Version: <!-- e.g. v0.0.8 -->
|
||||
* Honcho Client Version: <!-- e.g. Python v0.0.8 -->
|
||||
|
||||
---
|
||||
|
||||
### **Additional context**
|
||||
<!-- Add any other context or additional information about the problem here.-->
|
||||
|
||||
*
|
||||
|
||||
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
|
||||
|
||||
To expedite issue processing, please search open and closed issues before submitting a new one.
|
||||
|
||||
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
name: Bug report
|
||||
description: Something is broken or incorrect in Honcho (API, deriver, SDK, managed offering, etc.).
|
||||
title: "[Bug] "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for filing a bug. Please search [existing issues](https://github.com/plastic-labs/honcho/issues) first.
|
||||
|
||||
**Security vulnerability?** Do not use this form — report privately via [SECURITY.md](https://github.com/plastic-labs/honcho/blob/main/SECURITY.md).
|
||||
|
||||
**Memory / recall quality** (wrong or noisy conclusions, weak dialectic answers) with no crash? Prefer the **Memory / recall quality** template.
|
||||
|
||||
- type: dropdown
|
||||
id: deploy_mode
|
||||
attributes:
|
||||
label: Deploy mode
|
||||
description: Where are you running Honcho?
|
||||
options:
|
||||
- Managed (api.honcho.dev / app.honcho.dev)
|
||||
- Self-hosted
|
||||
- Unsure
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Honcho version
|
||||
description: Server image tag or release, and SDK version if you use one. Write "managed" if you are not self-hosting.
|
||||
placeholder: e.g. server v2.4.1, honcho-ai 2.1.0
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: Clear and concise description of what is wrong.
|
||||
placeholder: When I…, Honcho…
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: repro
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Minimal steps or a short script/API sequence. Redact secrets, JWTs, and production user content.
|
||||
placeholder: |
|
||||
1. Create a session with …
|
||||
2. POST /v3/... with body …
|
||||
3. Observe …
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs and evidence
|
||||
description: Relevant API or deriver logs or stack traces. Redact secrets and user content.
|
||||
render: shell
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Config knobs, deployment notes, screenshots, related issues/PRs.
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
name: "💉 Failing Test"
|
||||
about: "Report failing tests or CI jobs."
|
||||
title: "[Test] "
|
||||
labels: "Type: Test"
|
||||
assignees: ""
|
||||
|
||||
---
|
||||
|
||||
# **💉 Failing Test**
|
||||
|
||||
## **Which jobs/test(s) are failing**
|
||||
<!-- The CI jobs or tests that are failing -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
## **Reason for failure/description**
|
||||
<!-- Try to describe why the test is failing or what we are missing to make it pass. -->
|
||||
|
||||
---
|
||||
|
||||
### **Media prove**
|
||||
<!-- If applicable, add screenshots or videos to help explain your problem. -->
|
||||
|
||||
---
|
||||
|
||||
### **Additional context**
|
||||
<!-- Add any other context or additional information about the problem here. -->
|
||||
|
||||
*
|
||||
|
||||
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
|
||||
|
||||
To expedite issue processing, please search open and closed issues before submitting a new one.
|
||||
|
||||
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
name: Memory / recall quality
|
||||
description: Conclusions, representations, or dialectic answers are wrong, noisy, missing, or low-quality — not a hard crash.
|
||||
title: "[Quality] "
|
||||
labels: ["quality"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Use this when Honcho runs without erroring, but **memory formation or recall quality** is off (bad conclusions, missed facts, weak chat answers, polluted representations, etc.).
|
||||
|
||||
For crashes, 5xxs, auth failures, or incorrect API mechanics, use the **Bug report** template instead.
|
||||
|
||||
**Do not paste production user content, full peer representations, or secrets.** Redact or invent a minimal synthetic example.
|
||||
|
||||
- type: dropdown
|
||||
id: deploy_mode
|
||||
attributes:
|
||||
label: Deploy mode
|
||||
options:
|
||||
- Managed (api.honcho.dev / app.honcho.dev)
|
||||
- Self-hosted
|
||||
- Unsure
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Honcho version
|
||||
description: Server image tag or release, and SDK version if you use one. Write "managed" if you are not self-hosting.
|
||||
placeholder: e.g. server v2.4.1, honcho-ai 2.1.0
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: What is wrong with the quality?
|
||||
description: Describe the failure mode (noise, omission, contradiction, staleness, over/under-generalization, etc.).
|
||||
placeholder: After ingesting messages about X, Honcho concludes Y / chat answers Z…
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: repro
|
||||
attributes:
|
||||
label: Minimal scenario
|
||||
description: >
|
||||
Smallest synthetic message sequence or setup that triggers the issue.
|
||||
Prefer invented names/facts over real user data. Include observer/observed
|
||||
peer setup if relevant (self vs cross-peer).
|
||||
placeholder: |
|
||||
1. Peers: alice (user), bot (agent); session S
|
||||
2. Messages ingested: …
|
||||
3. Query / conclusion listing shows: …
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: config
|
||||
attributes:
|
||||
label: Relevant config
|
||||
description: >
|
||||
Custom instructions, provider/model, deriver/dream settings, or workspace/peer
|
||||
config that affects reasoning. Redact secrets.
|
||||
placeholder: |
|
||||
Provider/model: …
|
||||
Custom instructions: (summary or redacted)
|
||||
Other: …
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: evidence
|
||||
attributes:
|
||||
label: Evidence
|
||||
description: Redacted conclusion text, chat excerpts, or counts that show the failure. No production PII.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Frequency, scale (message/conclusion counts), related issues, workarounds.
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
name: Feature request
|
||||
description: Propose a new capability or an improvement to an existing one.
|
||||
title: "[Feature] "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Tell us what problem you are trying to solve. Concrete use cases beat abstract wishlists.
|
||||
|
||||
Questions about how to use Honcho belong on [Discord](https://discord.gg/honcho), not here.
|
||||
|
||||
- type: dropdown
|
||||
id: request_type
|
||||
attributes:
|
||||
label: Request type
|
||||
options:
|
||||
- New capability
|
||||
- Improve an existing capability
|
||||
- API / SDK surface
|
||||
- Managed offering
|
||||
- Docs / DX
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: Problem
|
||||
description: What is hard or impossible today? Who hits this?
|
||||
placeholder: I'm always frustrated when… / My integration needs…
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
description: What you would like Honcho to support. Sketches and API shapes welcome.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives considered
|
||||
description: Workarounds, other APIs, or designs you already tried or ruled out.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Links, prior art, screenshots, related issues/PRs.
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
name: "🚀🆕 Feature Request"
|
||||
about: "Suggest an idea or possible new feature for this project."
|
||||
title: ""
|
||||
labels: 'feature'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# **🚀 Feature Request**
|
||||
|
||||
## **Is your feature request related to a problem? Please describe.**
|
||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
## **Describe the solution you'd like**
|
||||
<!-- A clear and concise description of what you want to happen. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
## **Describe alternatives you've considered**
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
### **Additional context**
|
||||
<!-- Add any other context or additional information about the problem here.-->
|
||||
|
||||
*
|
||||
|
||||
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
|
||||
|
||||
To expedite issue processing, please search open and closed issues before submitting a new one.
|
||||
|
||||
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
name: Integration request
|
||||
description: Add Honcho to an app store, agent framework, plugin marketplace, or other third-party surface — or improve an existing integration.
|
||||
title: "[Integration] "
|
||||
labels: ["integration"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Use this when you want Honcho available in (or better supported by) an external product surface — app stores, agent frameworks, plugin marketplaces, IDE extensions, MCP clients, etc.
|
||||
|
||||
For core API/SDK product features that are not about a third-party surface, use the **Feature request** template instead.
|
||||
|
||||
- type: dropdown
|
||||
id: request_kind
|
||||
attributes:
|
||||
label: What kind of request is this?
|
||||
options:
|
||||
- New integration / listing (Honcho is not there yet)
|
||||
- Improve an existing integration
|
||||
- Official plugin / extension
|
||||
- Marketplace or app-store listing
|
||||
- Docs / guide for integrating with a specific tool
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: target
|
||||
attributes:
|
||||
label: Target product or platform
|
||||
description: Name of the app, framework, marketplace, or tool.
|
||||
placeholder: e.g. Claude Code, Cursor, CrewAI, OpenClaw, VS Code Marketplace…
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: target_url
|
||||
attributes:
|
||||
label: Link (if any)
|
||||
description: Docs, marketplace page, repo, or product URL.
|
||||
placeholder: https://…
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: why
|
||||
attributes:
|
||||
label: Why does this matter?
|
||||
description: Who would use it, and what does the integration unlock?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: shape
|
||||
attributes:
|
||||
label: What should the integration look like?
|
||||
description: >
|
||||
e.g. one-click install, MCP server listing, native memory backend,
|
||||
SDK recipe, plugin with slash commands, env-var setup, etc.
|
||||
Link to prior art or a sketch if you have one.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Related issues, community demand, constraints, offers to help build it.
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -8,6 +8,10 @@ assignees: ""
|
|||
---
|
||||
# **📚 Documentation Issue Report**
|
||||
|
||||
**Security vulnerability?** Do not use this form — report privately via [SECURITY.md](https://github.com/plastic-labs/honcho/blob/main/SECURITY.md).
|
||||
|
||||
GitHub issues are public. Redact secrets, JWTs, and production user content.
|
||||
|
||||
## **Describe the bug**
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
|
||||
|
|
@ -33,8 +37,8 @@ assignees: ""
|
|||
|
||||
---
|
||||
|
||||
### **Media prove**
|
||||
<!-- If applicable, add screenshots or videos to help explain your problem. -->
|
||||
### **Screenshots and videos**
|
||||
<!-- If applicable, add screenshots or videos to help explain your problem. Redact secrets and production content. -->
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -46,7 +50,7 @@ assignees: ""
|
|||
---
|
||||
|
||||
### **Additional context**
|
||||
<!-- Add any other context or additional information about the problem here.-->
|
||||
<!-- Add any other context about the problem. Redact secrets and production user content. -->
|
||||
|
||||
*
|
||||
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
name: "🚀➕ Enhancement Request"
|
||||
about: "Suggest an enhancement for this project. Improve an existing feature"
|
||||
title: ""
|
||||
labels: "Type: Enhancement"
|
||||
assignees: ""
|
||||
|
||||
---
|
||||
|
||||
# **🚀 Enhancement Request**
|
||||
|
||||
## **Is your enhancement request related to a problem? Please describe.**
|
||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
## **Describe the solution you'd like**
|
||||
<!-- A clear and concise description of what you want to happen. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
## **Describe alternatives you've considered**
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
### **Additional context**
|
||||
<!-- Add any other context or additional information about the problem here.-->
|
||||
|
||||
*
|
||||
|
||||
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
|
||||
|
||||
To expedite issue processing, please search open and closed issues before submitting a new one.
|
||||
|
||||
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
|
||||
|
|
@ -1,93 +0,0 @@
|
|||
---
|
||||
name: "⚠️ Security Report"
|
||||
about: "Report an issue to help the project improve."
|
||||
title: ""
|
||||
labels: "security"
|
||||
assignees: ""
|
||||
|
||||
---
|
||||
|
||||
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
|
||||
|
||||
READ CAREFULLY IF YOUR ISSUE REPORT CONTAINS SENSIBLE OR PRIVATE DATA:
|
||||
(data that might be leaked or subtracted from our servers due to this
|
||||
security issue).
|
||||
|
||||
If this security report (or the guide on how to "identify the security bug") includes
|
||||
certain personal information or involves personal identifiable data, or you believe
|
||||
that the data that you might leak by exposing the way on how to attack the project
|
||||
could be considered as a data leak or could violate the privacy of any kind of
|
||||
data or sensible data, please do not post it here and directly email the developer:
|
||||
(hello@plasticlabs.ai). You should post the issue with the least amount of
|
||||
sensible or private data as possible to help us manage the security issue, and
|
||||
with the extra data sent from your email to the developer (if any), we will deeply
|
||||
analyze and try to fix it as fast as possible.
|
||||
|
||||
If you are in doubt about the data that you might post here (screenshots or media
|
||||
also, count as data), please directly email us.
|
||||
|
||||
The data that must NOT be posted here:
|
||||
|
||||
* Legal and/or full names
|
||||
* Names or usernames combined with other identifiers like phone numbers or email addresses
|
||||
* Health or financial information (including insurance information, social security numbers, etc.)
|
||||
* Information about political or religious affiliations
|
||||
* Information about race, ethnicity, sexual orientation, gender, or other identifying information that could be used for discriminatory purposes
|
||||
|
||||
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
|
||||
|
||||
# **⚠️ Security Report**
|
||||
|
||||
## **Describe the security issue**
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
### **To Reproduce**
|
||||
|
||||
<!-- Steps to reproduce the error:
|
||||
(e.g.:)
|
||||
1. Use x argument / navigate to
|
||||
2. Fill this information
|
||||
3. Go to...
|
||||
4. See error -->
|
||||
|
||||
<!-- Write the steps here (add or remove as many steps as needed)-->
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
4.
|
||||
|
||||
---
|
||||
|
||||
### **Expected behaviour**
|
||||
<!-- A clear and concise description of what you expected to happen. -->
|
||||
|
||||
*
|
||||
|
||||
---
|
||||
|
||||
### **Media prove**
|
||||
<!-- If applicable, add screenshots or videos to help explain your problem. -->
|
||||
|
||||
---
|
||||
|
||||
### **Your environment**
|
||||
|
||||
<!-- use all the applicable bulleted list elements for this specific issue,
|
||||
and remove all the bulleted list elements that are not relevant for this issue. -->
|
||||
|
||||
* OS: <!--[e.g. Ubuntu 5.4.0-26-generic x86_64 / Windows 1904 ...]-->
|
||||
* Browser name and version:
|
||||
* Honcho Server Version: <!--[e.g. v0.0.1]-->
|
||||
* Honcho Client Version: <!--[e.g. Python v0.0.1]-->
|
||||
|
||||
---
|
||||
|
||||
### **Additional context**
|
||||
<!-- Add any other context or additional information about the problem here.-->
|
||||
|
||||
*
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
---
|
||||
name: "❓ Question or Support Request"
|
||||
about: "Questions and requests for support."
|
||||
title: ""
|
||||
labels: "question"
|
||||
assignees: ""
|
||||
|
||||
---
|
||||
|
||||
# **❓ Question or Support Request**
|
||||
|
||||
## **Describe your question or ask for support.**
|
||||
<!-- A clear and concise description of what your doubt is. -->
|
||||
|
||||
*
|
||||
|
||||
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
|
||||
|
||||
Before posting any questions or asking for support, first read the project's README.md file and
|
||||
(if there is any) the WIKI pages or any other additional documentation that might be listed
|
||||
in the project's README.md file.
|
||||
|
||||
To expedite issue processing, please search open and closed issues before submitting a new one.
|
||||
|
||||
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Report a security vulnerability
|
||||
url: https://github.com/plastic-labs/honcho/security/advisories/new
|
||||
about: Private vulnerability reporting only — do not file public security issues.
|
||||
- name: Question or support
|
||||
url: https://discord.gg/honcho
|
||||
about: Ask the community and maintainers on Discord.
|
||||
- name: Documentation
|
||||
url: https://honcho.dev/docs
|
||||
about: Guides, API reference, and self-hosting docs.
|
||||
|
|
@ -196,17 +196,21 @@ We welcome various types of contributions:
|
|||
When reporting bugs or requesting features:
|
||||
|
||||
1. Check if the issue already exists
|
||||
2. Use the appropriate issue template
|
||||
2. Use the appropriate [issue template](https://github.com/plastic-labs/honcho/issues/new/choose) (bug, memory/recall quality, feature, integration, or documentation)
|
||||
3. Provide clear reproduction steps for bugs
|
||||
4. Include relevant environment information
|
||||
4. Include relevant environment information (managed vs self-hosted, server version, SDK)
|
||||
5. Be specific about expected vs actual behavior
|
||||
6. Redact secrets, JWTs, and production user content
|
||||
|
||||
## Questions and Support
|
||||
|
||||
- **General questions** - Join our [Discord](http://discord.gg/honcho)
|
||||
- **Bug reports** - Use GitHub issues
|
||||
- **Feature requests** - Use GitHub issues with the feature request template
|
||||
- **Security issues** - Please email us privately rather than opening a public issue
|
||||
- **General questions** - Join our [Discord](https://discord.gg/honcho)
|
||||
- **Bug reports** - GitHub issues → Bug report template
|
||||
- **Memory / recall quality** - GitHub issues → Memory / recall quality template
|
||||
- **Feature requests** - GitHub issues → Feature request template
|
||||
- **Integrations / plugins / app-store listings** - GitHub issues → Integration request template
|
||||
- **Documentation issues** - GitHub issues → Documentation issue template
|
||||
- **Security issues** - Report **privately** only — see [`SECURITY.md`](./SECURITY.md) (GitHub Private Vulnerability Reporting or email). Do not open a public issue.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,31 @@
|
|||
# Security Policy
|
||||
|
||||
## Reporting a vulnerability
|
||||
|
||||
**Do not file a public GitHub issue for security vulnerabilities.**
|
||||
|
||||
Please report security issues privately using one of:
|
||||
|
||||
1. **[GitHub Private Vulnerability Reporting](https://github.com/plastic-labs/honcho/security/advisories/new)** (preferred)
|
||||
2. Email **<support@honcho.dev>** with subject line `[SECURITY] …`
|
||||
|
||||
Include as much of the following as you can:
|
||||
|
||||
- Description of the issue and its impact
|
||||
- Steps to reproduce, or a proof of concept
|
||||
- Affected component (API, deriver, auth/JWT, SDK, managed offering, etc.)
|
||||
- Honcho version or image tag, and whether you are on managed or self-hosted
|
||||
|
||||
Honcho stores conversational data and peer representations. **Do not** attach production user content, API keys, JWTs, or other secrets to a report unless we explicitly ask for a redacted sample.
|
||||
|
||||
## What to expect
|
||||
|
||||
We will acknowledge valid reports as soon as we can and will keep you updated on remediation status. Please give us a reasonable window to investigate and fix before any public disclosure.
|
||||
|
||||
## Supported versions
|
||||
|
||||
Security fixes are applied to the latest release on `main` and, when practical, to the most recent tagged release line. Older versions may not receive backports.
|
||||
|
||||
## Non-security bugs
|
||||
|
||||
For ordinary bugs, memory/recall quality issues, and feature requests, use the [issue templates](https://github.com/plastic-labs/honcho/issues/new/choose).
|
||||
|
|
@ -153,17 +153,21 @@ We welcome various types of contributions:
|
|||
When reporting bugs or requesting features:
|
||||
|
||||
1. Check if the issue already exists
|
||||
2. Use the appropriate issue template
|
||||
2. Use the appropriate [issue template](https://github.com/plastic-labs/honcho/issues/new/choose) (bug, memory/recall quality, feature, integration, or documentation)
|
||||
3. Provide clear reproduction steps for bugs
|
||||
4. Include relevant environment information
|
||||
4. Include relevant environment information (managed vs self-hosted, server version, SDK)
|
||||
5. Be specific about expected vs actual behavior
|
||||
6. Redact secrets, JWTs, and production user content
|
||||
|
||||
## Questions and Support
|
||||
|
||||
- **General questions** - Join our [Discord](http://discord.gg/honcho)
|
||||
- **Bug reports** - Use GitHub issues
|
||||
- **Feature requests** - Use GitHub issues with the feature request template
|
||||
- **Security issues** - Please email us privately rather than opening a public issue
|
||||
- **General questions** - Join our [Discord](https://discord.gg/honcho)
|
||||
- **Bug reports** - GitHub issues → Bug report template
|
||||
- **Memory / recall quality** - GitHub issues → Memory / recall quality template
|
||||
- **Feature requests** - GitHub issues → Feature request template
|
||||
- **Integrations / plugins / app-store listings** - GitHub issues → Integration request template
|
||||
- **Documentation issues** - GitHub issues → Documentation issue template
|
||||
- **Security issues** - Report **privately** only — see [`SECURITY.md`](https://github.com/plastic-labs/honcho/blob/main/SECURITY.md) (GitHub Private Vulnerability Reporting or email). Do not open a public issue.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -153,17 +153,21 @@ We welcome various types of contributions:
|
|||
When reporting bugs or requesting features:
|
||||
|
||||
1. Check if the issue already exists
|
||||
2. Use the appropriate issue template
|
||||
2. Use the appropriate [issue template](https://github.com/plastic-labs/honcho/issues/new/choose) (bug, memory/recall quality, feature, integration, or documentation)
|
||||
3. Provide clear reproduction steps for bugs
|
||||
4. Include relevant environment information
|
||||
4. Include relevant environment information (managed vs self-hosted, server version, SDK)
|
||||
5. Be specific about expected vs actual behavior
|
||||
6. Redact secrets, JWTs, and production user content
|
||||
|
||||
## Questions and Support
|
||||
|
||||
- **General questions** - Join our [Discord](http://discord.gg/honcho)
|
||||
- **Bug reports** - Use GitHub issues
|
||||
- **Feature requests** - Use GitHub issues with the feature request template
|
||||
- **Security issues** - Please email us privately rather than opening a public issue
|
||||
- **General questions** - Join our [Discord](https://discord.gg/honcho)
|
||||
- **Bug reports** - GitHub issues → Bug report template
|
||||
- **Memory / recall quality** - GitHub issues → Memory / recall quality template
|
||||
- **Feature requests** - GitHub issues → Feature request template
|
||||
- **Integrations / plugins / app-store listings** - GitHub issues → Integration request template
|
||||
- **Documentation issues** - GitHub issues → Documentation issue template
|
||||
- **Security issues** - Report **privately** only — see [`SECURITY.md`](https://github.com/plastic-labs/honcho/blob/main/SECURITY.md) (GitHub Private Vulnerability Reporting or email). Do not open a public issue.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue