chore: add contribution docs and issue/PR templates (#3)

This commit is contained in:
ilya-bov
2026-02-27 13:20:02 +03:00
committed by GitHub
parent ac760b4ada
commit 1357fd9b7f
9 changed files with 332 additions and 0 deletions

81
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,81 @@
name: Bug report
description: Report a reproducible problem in Eggent
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug. Please provide a minimal and reproducible report.
- type: textarea
id: summary
attributes:
label: Summary
description: Short description of the problem.
placeholder: The app crashes when...
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: List exact steps so we can reproduce.
placeholder: |
1. Go to...
2. Click...
3. See error...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
placeholder: It should...
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior
placeholder: It actually...
validations:
required: true
- type: dropdown
id: install_type
attributes:
label: Install/runtime mode
options:
- Docker setup
- Local setup (Node + npm)
- Other
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: App version, git commit, or branch name.
placeholder: main @ 1a2b3c4
- type: input
id: os
attributes:
label: OS
placeholder: macOS 15.5 / Ubuntu 24.04
validations:
required: true
- type: input
id: browser
attributes:
label: Browser (if relevant)
placeholder: Chrome 130, Safari 18, Firefox 130
- type: textarea
id: logs
attributes:
label: Logs and errors
description: Paste stack traces, console logs, or container logs.
render: shell
- type: textarea
id: additional
attributes:
label: Additional context
description: Screenshots, recordings, or related details.

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Questions and discussions
url: https://github.com/eggent-ai/eggent/discussions
about: Ask usage questions and discuss ideas.
- name: Security vulnerability report
url: https://github.com/eggent-ai/eggent/security/advisories/new
about: Report sensitive vulnerabilities privately.

View File

@@ -0,0 +1,58 @@
name: Feature request
description: Suggest an improvement for Eggent
title: "[Feature]: "
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for the suggestion. Clear problem statements help us prioritize better.
- type: textarea
id: problem
attributes:
label: Problem statement
description: What problem are you trying to solve?
placeholder: It is hard to...
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Describe what you want to happen.
placeholder: Add a setting/button/workflow that...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Workarounds or alternatives you considered.
- type: textarea
id: impact
attributes:
label: User impact
description: Who benefits and how much?
placeholder: This helps users who...
- type: dropdown
id: area
attributes:
label: Area
options:
- UI/UX
- Chat/Agents
- MCP integration
- Memory/Knowledge
- Automation/Cron
- Install/Deployment
- Docs
- Other
validations:
required: true
- type: checkboxes
id: checks
attributes:
label: Checklist
options:
- label: I searched existing issues and discussions first.
required: true

21
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,21 @@
## Summary
Describe the problem and the intent of this PR.
## What Changed
-
## How to Test
1.
2.
3.
## Checklist
- [ ] PR is focused on one topic.
- [ ] I ran `npm run lint`.
- [ ] I ran `npm run build`.
- [ ] I updated docs when behavior changed.
- [ ] I linked related issue(s).