The Open Framework for Building Agents
docs: welcome issue-based contribution plans (#4526)
Colton Padden3b69d6674a39
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.ymlindex 962f65e2a..f48093ea3 100644--- a/.github/ISSUE_TEMPLATE/bug_report.yml+++ b/.github/ISSUE_TEMPLATE/bug_report.yml@@ -1,11 +1,13 @@name: Bug report-description: Report a reproducible bug in eve.+description: Report a reproducible bug and optionally share a prompt for our agents.labels: ["bug"]body:- type: markdownattributes:value: |- Thanks for taking the time to file a bug report. Before opening a new issue:+ Thanks for taking the time to file a bug report. We welcome prompts as issues and greatly appreciate your investigation. If you have a fix in mind, include a prompt or short implementation plan for the team to review and run with our own coding agents, using our chosen models and skills. A prompt is optional; a reproducible report is valuable on its own, and you do not need to submit a pull request.++ Before opening a new issue:- [Search existing issues](https://github.com/vercel/eve/issues) and upvote instead of duplicating — it gets bugs fixed faster.- Verify the bug still reproduces on the **latest** eve release; it may already be fixed.@@ -100,15 +102,18 @@ body:- type: textareaid: implementation-promptattributes:- label: Suggested implementation prompt- description: Optionally provide a prompt a maintainer or coding agent could use to fix this bug after it is accepted. Include the expected behavior, constraints, and acceptance criteria rather than prescribing unnecessary implementation details.+ label: Prompt or implementation plan for our agents (optional)+ description: If you have a fix in mind, share a prompt the team can run. Include the expected behavior, relevant code, constraints, and how to validate the fix. Include implementation steps if you know them; a prompt is not required to report a bug.placeholder: |- Fix ...+ Fix the bug using the reproduction and expected behavior above.++ Relevant code:+ - ...- Requirements:+ Constraints and proposed steps:- ...- Acceptance criteria:+ Validation:- ...validations:required: falsediff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.ymlindex 0dc26034e..4e26764d4 100644--- a/.github/ISSUE_TEMPLATE/feature_request.yml+++ b/.github/ISSUE_TEMPLATE/feature_request.yml@@ -1,7 +1,13 @@name: Feature request-description: Suggest an idea or improvement for eve.+description: Suggest an improvement or share a prompt for the team's coding agents.labels: ["enhancement"]body:+ - type: markdown+ attributes:+ value: |+ We welcome prompts as issues and greatly appreciate your ideas and investigation. Share the problem and desired outcome below. If you have a prompt or implementation plan in mind, include it for the team to review and run with our own coding agents, using our chosen models and skills.++ Start with a short prompt; a detailed plan is optional, and you do not need to submit a pull request. Search [existing issues](https://github.com/vercel/eve/issues) first to avoid duplicating active work. See [Contributing to eve](https://github.com/vercel/eve/blob/main/CONTRIBUTING.md#proposing-a-change) for guidance.- type: textareaid: problemattributes:@@ -19,15 +25,18 @@ body:- type: textareaid: implementation-promptattributes:- label: Suggested implementation prompt- description: Optionally provide a prompt a maintainer or coding agent could use to implement this proposal after it is accepted. Include the intended behavior, constraints, and acceptance criteria rather than prescribing unnecessary implementation details.+ label: Prompt or implementation plan for our agents (optional)+ description: Share a prompt the team can run if the proposal is accepted. Describe the intended behavior, relevant code or docs, constraints, and how to validate the result. Include implementation steps if you know them; an incomplete prompt is welcome.placeholder: |- Implement ...+ Implement the behavior described above.++ Relevant code or docs:+ - ...- Requirements:+ Constraints and proposed steps:- ...- Acceptance criteria:+ Validation:- ...validations:required: falsediff --git a/.github/pull_request_template.md b/.github/pull_request_template.mdindex 232a7f999..f25bab335 100644--- a/.github/pull_request_template.md+++ b/.github/pull_request_template.md@@ -18,8 +18,6 @@ results or limitations. Explain when tests are not applicable.### Checklist-- [ ] This change was requested or approved by a maintainer-- [ ] I ran the relevant checks from `CONTRIBUTING.md`- [ ] I added tests and documentation where relevant- [ ] I added a changeset if this touches the published `eve` package- [ ] DCO sign-off passes for every commit (`git commit --signoff`)diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex f06d7fbe2..25dbfa8a2 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -1,12 +1,21 @@# Contributing to eve-Thanks for your interest in contributing! This guide covers everything you need to get the repo running locally and land a change.+Thanks for your interest in contributing to eve! We greatly appreciate bug+reports, feature proposals, and prompts or implementation plans shared through+issues.++If you are an external contributor, start with an+[issue](https://github.com/vercel/eve/issues/new/choose) rather than a pull+request. See [Proposing a change](#proposing-a-change) for what to include.++The rest of this guide covers local development and the team's implementation+and pull request workflow.## Signed commitsThis repository requires verified commit signatures on protected branches.-Before contributing, configure Git to sign your commits with a GitHub-verified+Before committing code, configure Git to sign your commits with a GitHub-verifiedGPG, SSH, or S/MIME key. Unsigned commits will be rejected by repository rulesand need to be rewritten as signed commits before they can be merged.@@ -168,18 +177,31 @@ User-facing docs live in [`docs/`](./docs) and are published with the `eve` npm## Proposing a change-If you are an external contributor and have not been invited to implement a-change, open an issue instead of a pull request. Search the existing issues,-discussions, and pull requests first so you do not duplicate active work. Use-the relevant issue template to describe the problem, use case, or bug-reproduction. You may also include a suggested implementation prompt that a-maintainer or coding agent could use after the proposal is accepted.+External contributions should come through issues rather than unsolicited+pull requests. Search the existing issues, discussions, and pull requests+first so you do not duplicate active work, then use the+[relevant issue template](https://github.com/vercel/eve/issues/new/choose).++We use our own coding agents to implement accepted proposals. This lets us+control which models and skills the agents use and how changes are validated.+We welcome prompts as issues. Your investigation, prompt, or implementation+plan helps us understand the problem and gives our agents a concrete starting+point.+You do not need to write the code or open a pull request to contribute.++Describe the problem, use case, or bug reproduction. If you have a change in+mind, include a prompt or short implementation plan that the team can review+and run with its own agents. Useful details include:++- Explain the desired behavior and give a concrete user story or reproduction.+- Identify the relevant code or docs and outline the changes you recommend.+- Note constraints, trade-offs, and any public API or dependency changes.+- Describe how to validate the result, including relevant tests and docs updates.-For changes to public APIs, agent behavior, compiler/runtime internals,-dependencies, generated artifacts, fixture contracts, or any non-trivial-implementation detail, wait for maintainer agreement before investing in an-implementation. The goal is to agree that the problem is real and that the-proposed direction fits eve before review shifts to code.+Start with a short prompt or plan focused on the outcome. Once a maintainer+agrees on the direction, they may ask for more detail. Prompts and plans are+optional: you can report a bug or request a feature without knowing how to+implement it. Share what you know, even if your proposal is incomplete.To make a proposal easier to evaluate:@@ -191,9 +213,9 @@ To make a proposal easier to evaluate:package should keep runtime dependencies minimal.- Do not propose public behavior based only on a hypothetical use case. Includea concrete user story or, for bugs, a reproduction.-- Do not claim an issue silently. Wait for a maintainer to invite an- implementation, and check the thread first in case someone else is already- working on it.+- Check the issue thread before developing a prompt or plan in case someone+ else is already working on it. Coordinate with maintainers rather than+ assuming an issue is assigned to you.## Submitting a pull request