Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 52 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,64 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
name: 🐞 Bug Report
description: Report a reproducible bug or unexpected behavior in Vibekit
title: "[BUG] <short summary>"
labels: ["bug", "needs-triage"]

body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug 🧠
Please fill out the details below to help us reproduce and fix it faster.

- type: textarea
id: description
attributes:
label: Bug Description
description: Describe what happened and what you expected
placeholder: What went wrong?
label: 🧩 Bug Description
description: What happened and what you expected to happen.
placeholder: |
When running `vibekit dev`, I expected the preview to start but instead got a TypeError.
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
label: 🧪 Steps to Reproduce
description: Please list the exact steps to reproduce the issue.
placeholder: |
1. Run `npm install vibekit`
2. Execute `vibekit dev`
3. Observe the crash message in console
validations:
required: true

- type: textarea
id: environment
attributes:
label: 💻 Environment
description: Provide your setup details.
placeholder: |
1.
2.
3.
- OS: Ubuntu 22.04
- Node.js: v20.x
- Vibekit: 0.2.1
- Docker: 27.0.3
validations:
required: false

- type: textarea
id: logs
attributes:
label: 📸 Logs / Screenshots
description: Paste any relevant logs or screenshots.
placeholder: Paste console output, error messages, or screenshots here.
validations:
required: false

- type: textarea
id: additional
attributes:
label: 🧠 Additional Context
description: Any other details you think might help us understand or reproduce the issue.
placeholder: Related issues, workarounds, or configurations.
validations:
required: false
required: false
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: 📚 Documentation Update
description: Suggest an improvement or correction in Vibekit documentation
title: "[DOCS] <short title>"
labels: ["documentation", "good first issue"]
body:
- type: markdown
attributes:
value: |
Thank you for helping improve Vibekit documentation!
Please provide details to make it clear and actionable.

- type: textarea
id: section
attributes:
label: Section of Documentation
description: Specify which part of the docs needs updating (README, CONTRIBUTING.md, examples, etc.)
placeholder: README.md, examples/usage.md
validations:
required: true

- type: textarea
id: issue
attributes:
label: Describe the Issue
description: What is unclear, missing, or outdated?
placeholder: The CLI section is missing instructions for Windows users.
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: Suggested Changes
description: How should this be updated or improved?
placeholder: Add Windows-specific setup steps.
validations:
required: false

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Any extra details, references, or links.
placeholder: Related issues, links, or screenshots.
validations:
required: false
59 changes: 51 additions & 8 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,56 @@
name: Feature Request
description: Suggest an idea for this project
title: "[Feature]: "
labels: ["enhancement"]
name: 🚀 Feature Request
description: Suggest a new idea, improvement, or enhancement for Vibekit
title: "[FEATURE] <short summary>"
labels: ["enhancement", "needs-triage"]

body:
- type: markdown
attributes:
value: |
Thank you for proposing a feature 💡
Please provide as much detail as possible to help us understand the problem and potential solution.

- type: textarea
id: description
attributes:
label: Feature Description
description: What feature would you like to see?
placeholder: Describe the feature you'd like
label: 🧩 Feature Description
description: Describe the feature you would like to see implemented.
placeholder: I would like Vibekit to support multiple agent providers in the same sandbox session.
validations:
required: true

- type: textarea
id: problem
attributes:
label: 🔍 Problem to Solve
description: Explain the problem this feature would address.
placeholder: Currently, the SDK only supports a single agent provider at a time.
validations:
required: false

- type: textarea
id: proposed_solution
attributes:
label: 💡 Proposed Solution
description: Optional. Share your ideas for how this feature could work.
placeholder: Add a configuration object that allows registering multiple agent providers.
validations:
required: false

- type: textarea
id: alternatives
attributes:
label: 🔄 Alternatives Considered
description: Optional. List any alternative solutions or workarounds you considered.
placeholder: Currently, we can only run multiple agent providers sequentially in separate containers.
validations:
required: false

- type: textarea
id: additional_context
attributes:
label: 🧠 Additional Context
description: Any other context, references, or links that might help.
placeholder: Related issues, references, or example implementations.
validations:
required: true
required: false
25 changes: 18 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
## Description
<!-- A brief summary of the changes in this pull request. -->
## 🧾 Description
Provide a brief summary of the changes in this pull request. Include context, reasoning, and references to relevant issues.

## Related Issue
Fixes #<issue number>
## 🔗 Related Issue
Closes #<issue number> (if applicable)

## Checklist
- [ ] I tested my changes
- [ ] I reviewed my own code
## ✅ Type of Change
- [ ] 🐞 Bug fix
- [ ] 🚀 New feature
- [ ] 🧱 Refactor / internal change
- [ ] 📚 Documentation
- [ ] 🧪 Tests

## 🛠 Checklist
- [ ] I have tested my changes locally
- [ ] All CI checks pass
- [ ] Documentation updated (if applicable)

## 🧠 Additional Context
Any extra context, screenshots, or notes for reviewers.
7 changes: 6 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,9 @@ jobs:
- run: npm install -g npm@latest
- run: npm ci
- run: npm run build
- run: npm test -- --coverage
- run: npm test -- --coverage





Loading