From 34bed3f8e4302c4b6ab5cf4e6557c178ba09ce60 Mon Sep 17 00:00:00 2001 From: Peyton Montei Date: Fri, 13 Feb 2026 11:56:19 -0800 Subject: [PATCH 1/2] Updates to CONTRIBUTING.md --- CONTRIBUTING.md | 71 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 59 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d27ae915..85340edbb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,21 @@ Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before participating. --- +## Before You Code: Discuss First + +The fastest way to get a contribution merged is to align with maintainers before writing code. Please **open an issue first** using our [issue templates](https://github.com/entireio/cli/issues/new/choose) and wait for maintainer feedback before starting implementation. + +### Contribution Workflow + +1. **Open an issue** describing the problem or feature +2. **Wait for maintainer feedback** -- we may have relevant context or plans +3. **Get approval** before starting implementation +4. **Submit your PR** referencing the approved issue +5. **Address all feedback** including automated co-pilot comments +6. **Maintainer review and merge** + +--- + ## First-Time Contributors New to the project? Welcome! Here's how to get started: @@ -225,23 +240,55 @@ These are Go implementations that integrate Entire with different AI coding tool ## Submitting a Pull Request -### Prerequisites +### Before You Submit -1. **Install Entire** - Install the latest version of the Entire CLI (see [installation docs](https://docs.entire.io/cli/installation)), verify with `entire version`. Entire is already configured in the repository, so no need to run `entire enable` -2. **Pass linting** - Run `mise run lint` (includes golangci-lint, gofmt, gomod, shellcheck) -3. **Pass tests** - Run `mise run test` to verify your changes -4. **Add tests** - Include tests for new Go code and functionality -5. **Include checkpoint trailers** - All commits must have Entire checkpoint trailers from your sessions +- **Related issue exists and is approved** -- Your PR references an issue where a maintainer has acknowledged the approach. (Exceptions: documentation fixes, typo corrections, and `good-first-issue` items.) +- **Linting passes** -- Run `mise run lint` (includes golangci-lint, gofmt, gomod, shellcheck) +- **Tests pass** -- Run `mise run test` to verify your changes +- **Tests included** -- New Go code and functionality should have accompanying tests +- **Entire checkpoint trailers included** -- See [Using Entire While Contributing](#using-entire-while-contributing) below + +PRs that skip these steps are likely to be closed without merge. ### Submitting 1. **Push** your branch to your fork 2. **Open a PR** against the `main` branch -3. **Fill out** the PR template with: - - Clear description of changes - - Related issue numbers - - Testing done -4. **Wait for review** - maintainers will provide feedback +3. **Describe your changes** -- Link the related issue, summarize what changed and what testing you did +4. **Address co-pilot feedback** -- See [Responding to Automated Review](#responding-to-automated-review) +5. **Wait for maintainer review** + +--- + +## Responding to Automated Review + +Co-pilot agent reviews every PR and provides feedback on code quality, potential bugs, and project conventions. + +**Read and respond to every co-pilot comment.** PRs with unaddressed co-pilot feedback will not move to maintainer review. + +- **Fixed** -- Push a commit addressing the issue. +- **Disagree** -- Reply explaining your reasoning. The co-pilot isn't always right. +- **Question** -- Ask for clarification. We're happy to help. + +Addressing co-pilot feedback upfront is the fastest path to maintainer review. + +--- + +## Using Entire While Contributing + +We use Entire on Entire. When contributing, install the Entire CLI and let it capture your coding sessions -- this gives us valuable dogfooding data and helps improve the tool. + +### Setup + +Install the latest version of the Entire CLI (see [installation docs](https://docs.entire.io/cli/installation)) and verify with `entire version`. Entire is already configured in this repository, so there's no need to run `entire enable`. + +### Checkpoint Trailers + +All commits should include `Entire-Checkpoint` trailers from your sessions. These are added automatically by the `prepare-commit-msg` hook when Entire is enabled. The trailers link your commits to session metadata on the `entire/checkpoints/v1` branch. + +### Sessions Branch + +When you push your PR branch, Entire can automatically push the `entire/checkpoints/v1` branch alongside it (if `push_sessions` is enabled in your settings). Include this in your PR so maintainers can review the session context behind your changes. --- @@ -296,4 +343,4 @@ Join the Entire community: --- -Thank you for contributing! \ No newline at end of file +Thank you for contributing! From ef092a62bee6a0952e419d41bbc8b5ac7bb52511 Mon Sep 17 00:00:00 2001 From: Peyton Montei Date: Fri, 13 Feb 2026 12:13:43 -0800 Subject: [PATCH 2/2] Co-pilot feedback --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85340edbb..762a0966d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ The fastest way to get a contribution merged is to align with maintainers before 2. **Wait for maintainer feedback** -- we may have relevant context or plans 3. **Get approval** before starting implementation 4. **Submit your PR** referencing the approved issue -5. **Address all feedback** including automated co-pilot comments +5. **Address all feedback** including automated Copilot comments 6. **Maintainer review and merge** --- @@ -255,7 +255,7 @@ PRs that skip these steps are likely to be closed without merge. 1. **Push** your branch to your fork 2. **Open a PR** against the `main` branch 3. **Describe your changes** -- Link the related issue, summarize what changed and what testing you did -4. **Address co-pilot feedback** -- See [Responding to Automated Review](#responding-to-automated-review) +4. **Address Copilot feedback** -- See [Responding to Automated Review](#responding-to-automated-review) 5. **Wait for maintainer review** --- @@ -264,13 +264,13 @@ PRs that skip these steps are likely to be closed without merge. Co-pilot agent reviews every PR and provides feedback on code quality, potential bugs, and project conventions. -**Read and respond to every co-pilot comment.** PRs with unaddressed co-pilot feedback will not move to maintainer review. +**Read and respond to every Copilot comment.** PRs with unaddressed Copilot feedback will not move to maintainer review. - **Fixed** -- Push a commit addressing the issue. -- **Disagree** -- Reply explaining your reasoning. The co-pilot isn't always right. +- **Disagree** -- Reply explaining your reasoning. The Copilot isn't always right. - **Question** -- Ask for clarification. We're happy to help. -Addressing co-pilot feedback upfront is the fastest path to maintainer review. +Addressing Copilot feedback upfront is the fastest path to maintainer review. ---