feat: add CONTRIBUTING.md, GitHub Issue templates, contrib:open label convention
CONTRIBUTING.md: - Two tracks: humans (GitHub flow) and agents (beadboard-driver + bd) - Copy-pasteable agent instructions for quick setup - PR size guidelines (under 100 lines preferred, 200+ needs issue first) - Quality gates, claim workflow, professional conduct expectations - beadboard-driver and bd setup for agent contributors GitHub Issue templates: - Bug report: structured fields (steps, platform, Dolt status, versions) - Feature request: problem/proposal/area, opt-in to implement - Config: links to Discord and contrib:open issue filter contrib:open labels: - Tagged 4 orchestrator beads for community contribution - Left session race condition (beadboard-4v7) as internal README: - Updated banner to link to CONTRIBUTING.md - Updated Contributing section with Discord link and contrib:open workflow Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
4bc24bc160
commit
f29c0e3cba
6 changed files with 323 additions and 12 deletions
75
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
75
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
name: Bug Report
|
||||
description: Something is broken
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting! A maintainer will create a corresponding bead to track this.
|
||||
|
||||
- type: input
|
||||
id: summary
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: One sentence.
|
||||
placeholder: "Dashboard crashes when opening graph view with no Dolt running"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: What did you do to hit this?
|
||||
placeholder: |
|
||||
1. Clone repo, npm install
|
||||
2. Run `beadboard start` (no Dolt)
|
||||
3. Click Graph tab
|
||||
4. See error in console
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: What should have happened?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: What happened instead? Include error messages if any.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: platform
|
||||
attributes:
|
||||
label: Platform
|
||||
description: OS and version
|
||||
placeholder: "macOS 15.3 / Windows 11 / Ubuntu 24.04"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: versions
|
||||
attributes:
|
||||
label: Versions
|
||||
description: "Output of: node -v, bd --version, beadboard --version"
|
||||
placeholder: "Node 20.11, bd 0.61.0, beadboard 0.1.0"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: dolt
|
||||
attributes:
|
||||
label: Dolt installed?
|
||||
options:
|
||||
- "Yes, running"
|
||||
- "Yes, not running"
|
||||
- "No"
|
||||
validations:
|
||||
required: true
|
||||
9
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
9
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Discord
|
||||
# TODO: replace with actual Discord invite link
|
||||
url: https://discord.gg/YOUR_INVITE
|
||||
about: Chat with the community, coordinate on contributions, get help
|
||||
- name: Available work
|
||||
url: https://github.com/zenchantlive/beadboard/issues?q=is%3Aissue+is%3Aopen+label%3Acontrib%3Aopen
|
||||
about: Browse issues tagged for community contribution
|
||||
56
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
56
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
name: Feature Request
|
||||
description: Suggest something new
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Got an idea? Describe it below. If it's approved, we'll create a bead and tag it `contrib:open` if it's available for community work.
|
||||
|
||||
- type: input
|
||||
id: summary
|
||||
attributes:
|
||||
label: What do you want?
|
||||
description: One sentence.
|
||||
placeholder: "A public 'contribute' view in the dashboard showing contrib:open beads"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What problem does this solve?
|
||||
description: Why do you need this? What's the pain without it?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: How should it work?
|
||||
description: Describe the behavior you're imagining. Doesn't need to be detailed — just enough to understand the idea.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Area
|
||||
options:
|
||||
- Dashboard (UI/views)
|
||||
- CLI (bb/beadboard)
|
||||
- Orchestrator (bb-pi)
|
||||
- Agent communication (mail/reservations)
|
||||
- Beads integration (bd)
|
||||
- beadboard-driver skill
|
||||
- Documentation
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: contribution
|
||||
attributes:
|
||||
label: Would you like to work on this?
|
||||
options:
|
||||
- label: "I'd like to implement this myself (or have my agent do it)"
|
||||
Loading…
Add table
Add a link
Reference in a new issue