mirror of
https://github.com/bookorbit/bookorbit.git
synced 2026-11-03 00:11:37 -06:00
chore: add community and help issue forms
Keep questions and community conversations in GitHub Issues with clear forms and guidance. Remove disabled Discussions links and exempt community topics from stale closure. Closes #1046
This commit is contained in:
neon
@@ -1,8 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Questions and Discussions
|
||||
url: https://github.com/bookorbit/bookorbit/discussions
|
||||
about: Ask questions, get help with your setup, or share how you use BookOrbit
|
||||
- name: Documentation
|
||||
url: https://bookorbit.app
|
||||
about: Read the full documentation at bookorbit.app
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
name: Community Discussion
|
||||
description: Discuss workflows and ideas, share your setup, or introduce companion apps
|
||||
title: "[Discussion] "
|
||||
labels: ["discussion", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Use this space to talk with other BookOrbit users about workflows, ideas, companion apps,
|
||||
integrations, or your setup. You do not need approval or assignment to participate.
|
||||
|
||||
Browse [existing community conversations](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Adiscussion)
|
||||
before starting a new topic. If you need troubleshooting help, use
|
||||
[Question / Help](https://github.com/bookorbit/bookorbit/issues/new?template=question.yml).
|
||||
For a concrete improvement, use the
|
||||
[Feature Request](https://github.com/bookorbit/bookorbit/issues/new?template=feature_request.yml) form.
|
||||
|
||||
Do not share passwords, tokens, private book content, or other sensitive information.
|
||||
Report security vulnerabilities privately using the
|
||||
[security policy](https://github.com/bookorbit/bookorbit/blob/main/.github/SECURITY.md).
|
||||
|
||||
- type: textarea
|
||||
id: topic
|
||||
attributes:
|
||||
label: What would you like to discuss or share?
|
||||
description: Introduce your topic and give enough context for others to join the conversation.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Links, examples, or screenshots (optional)
|
||||
description: Add relevant resources and remove sensitive information from screenshots.
|
||||
@@ -0,0 +1,59 @@
|
||||
name: Question / Help
|
||||
description: Ask about setup, configuration, troubleshooting, or using BookOrbit
|
||||
title: "[Help] "
|
||||
labels: ["support", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Questions are welcome, even if you are unsure whether something is a bug.
|
||||
You do not need approval or assignment to ask for help.
|
||||
|
||||
Check the [documentation](https://bookorbit.app) and
|
||||
[existing help requests](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Asupport)
|
||||
for an answer first. If you still need help, ask here.
|
||||
|
||||
Do not include passwords, tokens, private book content, or other sensitive information in
|
||||
logs or screenshots. Report security vulnerabilities privately using the
|
||||
[security policy](https://github.com/bookorbit/bookorbit/blob/main/.github/SECURITY.md).
|
||||
|
||||
NAS and network storage configurations are unsupported. For storage-related problems,
|
||||
reproduce the problem on supported local storage before asking for troubleshooting help.
|
||||
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: What do you need help with?
|
||||
description: Describe what you want to achieve and where you are stuck.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: tried
|
||||
attributes:
|
||||
label: What have you tried? (optional)
|
||||
description: Share any documentation, settings, or troubleshooting steps you have tried.
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Your setup (optional)
|
||||
description: Include the details relevant to your question.
|
||||
placeholder: |
|
||||
- BookOrbit version/image tag:
|
||||
- Deployment: Docker / manual
|
||||
- OS:
|
||||
- Client: web browser / iOS / Kobo / KOReader / other
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant logs (optional)
|
||||
description: Include only relevant excerpts and remove sensitive information before posting.
|
||||
render: shell
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots (optional)
|
||||
description: Remove sensitive information before attaching screenshots.
|
||||
@@ -24,7 +24,7 @@ jobs:
|
||||
stale-issue-label: stale
|
||||
stale-pr-label: stale
|
||||
remove-pr-stale-when-updated: false
|
||||
exempt-issue-labels: "pinned,security"
|
||||
exempt-issue-labels: "pinned,security,discussion"
|
||||
stale-issue-message: >
|
||||
This issue has been inactive for 60 days. It will be closed in 14 days
|
||||
unless there is new activity. If this is still relevant, please leave a
|
||||
|
||||
@@ -201,11 +201,14 @@ When adding user-facing text in code, add the Vue I18n key only to `client/src/l
|
||||
## Support
|
||||
|
||||
- **Support development:** [Open Collective](https://opencollective.com/bookorbit)
|
||||
- **Questions and discussion:** [GitHub Discussions](https://github.com/bookorbit/bookorbit/discussions)
|
||||
- **Questions and help:** [Ask in GitHub Issues](https://github.com/bookorbit/bookorbit/issues/new?template=question.yml) or [browse help requests](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Asupport).
|
||||
- **Community conversations:** [Start a conversation](https://github.com/bookorbit/bookorbit/issues/new?template=discussion.yml) or [browse community topics](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Adiscussion).
|
||||
- **Bug reports:** [GitHub Issues](https://github.com/bookorbit/bookorbit/issues/new?template=bug_report.yml)
|
||||
- **Feature requests:** [GitHub Issues](https://github.com/bookorbit/bookorbit/issues/new?template=feature_request.yml)
|
||||
- **Security vulnerabilities:** Follow the private reporting process in the [Security Policy](.github/SECURITY.md).
|
||||
|
||||
Questions are welcome, even if you are unsure whether something is a bug. Share workflows, your setup, or companion apps in community conversations. See the [community guide](docs/COMMUNITY.md) for choosing a category and how topics are handled.
|
||||
|
||||
## License and Attribution
|
||||
|
||||
Copyright (C) 2025-2026 neon and BookOrbit contributors.
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
# BookOrbit Community
|
||||
|
||||
GitHub Issues is the home for BookOrbit questions, help, and community conversations, alongside bug reports and feature requests. Questions are welcome, even if you are unsure whether something is a bug. You do not need approval or assignment to ask a question or start a conversation.
|
||||
|
||||
## Choose a Category
|
||||
|
||||
| Category | When to use it | Browse topics |
|
||||
| ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| [Question / Help](https://github.com/bookorbit/bookorbit/issues/new?template=question.yml) | Setup, configuration, troubleshooting, and using BookOrbit. | [Help requests](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Asupport) |
|
||||
| [Community Discussion](https://github.com/bookorbit/bookorbit/issues/new?template=discussion.yml) | Workflows, ideas, sharing your setup, companion apps, integrations, and show-and-tell. | [Community conversations](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Adiscussion) |
|
||||
| [Bug Report](https://github.com/bookorbit/bookorbit/issues/new?template=bug_report.yml) | Something is broken or behaves differently than documented. | [Bug reports](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Abug) |
|
||||
| [Feature Request](https://github.com/bookorbit/bookorbit/issues/new?template=feature_request.yml) | A concrete new capability or improvement. | [Feature requests](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Afeature) |
|
||||
|
||||
Search existing topics, including closed issues, before opening a new one. If an existing topic answers your question, you can use it directly. If your situation differs, open a new topic and link the relevant one. The [documentation](https://bookorbit.app) is also a good place to start.
|
||||
|
||||
Keep one topic per issue, use a descriptive title, and be respectful of other users and maintainers. Community help depends on people's available time; opening an issue does not guarantee a response.
|
||||
|
||||
## Asking for Help
|
||||
|
||||
Describe what you want to achieve and where you are stuck. If relevant, include what you have tried, your BookOrbit version, deployment method, and client or device. Logs and screenshots are optional; share only relevant excerpts and remove passwords, tokens, private book content, and other sensitive information.
|
||||
|
||||
NAS and network storage configurations are unsupported. Storage-related problems must be reproduced on supported local storage before requesting troubleshooting help. See [unsupported storage configurations](../README.md#unsupported-storage-configurations).
|
||||
|
||||
Do not report security vulnerabilities in public issues. Follow the private reporting process in the [security policy](../.github/SECURITY.md).
|
||||
|
||||
## How Topics Are Handled
|
||||
|
||||
- New topics receive `needs-triage`. Maintainers remove it after reviewing the category and any next steps.
|
||||
- Help requests use `support`. The `help wanted` label is reserved for contribution opportunities.
|
||||
- If a help request reveals a bug, maintainers can replace `support` with `bug` and ask for any missing reproduction details. The existing issue and conversation stay together.
|
||||
- When a question is answered, a maintainer adds `answered`, summarizes the solution or links to the helpful comment, and closes the issue. GitHub Issues does not have an accepted-answer feature. An unanswered issue closed for inactivity does not receive `answered`.
|
||||
- Community topics use `discussion` and are exempt from automatic stale closure. Maintainers can still close duplicates or topics that have reached a conclusion.
|
||||
- If a conversation produces actionable work, create a linked bug report or feature request and keep the community conversation available for context. An idea being discussed does not mean it is approved for implementation.
|
||||
- Other inactive issues, including help requests, receive a stale warning after 60 days and close after another 14 days without activity. If help is still needed, leave an update before closure or request reopening afterward. Maintainers can use `pinned` to exempt a topic from stale closure.
|
||||
|
||||
Before implementing a change, follow the approval and assignment process in [CONTRIBUTING.md](CONTRIBUTING.md). Those requirements apply to code contributions, not to asking for help or joining a conversation.
|
||||
@@ -13,6 +13,8 @@ Thanks for your interest in contributing to BookOrbit. Whether you are fixing a
|
||||
|
||||
## Where to Start
|
||||
|
||||
For usage questions, setup help, or community conversations, see the [community guide](COMMUNITY.md). You do not need approval or assignment to ask a question or participate.
|
||||
|
||||
Not sure what to work on? Look for issues tagged with:
|
||||
|
||||
- [`good first issue`](../../labels/good%20first%20issue) - Scoped tasks with clear acceptance criteria. Great for your first contribution.
|
||||
@@ -34,7 +36,7 @@ The rest of this guide still applies (issue first, PR template, etc.), but expec
|
||||
|
||||
## Security Issues
|
||||
|
||||
Do **not** open public issues for security vulnerabilities. Use GitHub's [private vulnerability reporting](../../security/advisories/new) instead. See [SECURITY.md](../.github/SECURITY.md) for details.
|
||||
Do **not** open public issues for security vulnerabilities. Use GitHub's [private vulnerability reporting](https://github.com/bookorbit/bookorbit/security/advisories/new) instead. See [SECURITY.md](../.github/SECURITY.md) for details.
|
||||
|
||||
---
|
||||
|
||||
@@ -48,8 +50,9 @@ This is the end-to-end journey from idea to merged PR. Each phase builds on the
|
||||
> contributor. PRs without prior approval and assignment will be closed without review.
|
||||
|
||||
- Browse [open issues](../../issues) for something you want to tackle.
|
||||
- If you have a new idea, open one using the [bug report](../../issues/new?template=bug_report.yml) or [feature request](../../issues/new?template=feature_request.yml) template.
|
||||
- Not sure if your idea fits the roadmap? Ask in a new issue before investing time.
|
||||
- Report a problem using the [bug report](https://github.com/bookorbit/bookorbit/issues/new?template=bug_report.yml) form, or propose a concrete improvement using the [feature request](https://github.com/bookorbit/bookorbit/issues/new?template=feature_request.yml) form.
|
||||
- For setup or usage questions, use [Question / Help](https://github.com/bookorbit/bookorbit/issues/new?template=question.yml).
|
||||
- Not sure if your idea fits the roadmap? Start a [Community Discussion](https://github.com/bookorbit/bookorbit/issues/new?template=discussion.yml) before investing time.
|
||||
|
||||
### Phase 2: Get Maintainer Approval
|
||||
|
||||
|
||||
Reference in New Issue
Block a user