Skip to content

docs(contributing): scope contribution areas to the CLI - #2224

Merged
cristim merged 1 commit into
mainfrom
docs/contributing-cli-scope
Oct 16, 2026
Merged

cristim merged 1 commit into
mainfrom
docs/contributing-cli-scope

Conversation

@cristim

@cristim cristim commented Oct 16, 2026

Copy link
Copy Markdown
Member

Closes #1177

Summary

CONTRIBUTING.md listed some contribution areas that this repo doesn't own. This PR changes the "Areas for Contribution" section to point each of them at the repo that does:

  • The web dashboard, REST API and deployment work (Terraform, CloudFormation) live in cloud-commitments-platform. I removed them from the lists and added one pointer paragraph.
  • The AWS, Azure and GCP provider and service implementations live in cloud-commitments-go, as go.mod and CONTRIBUTING.md:204 already say. That High Priority item now reads "Command and flag support for additional services", with a link to that repo.

The issue's other findings were already fixed on main:

  • CONTRIBUTING.md:51 and :88 say Go 1.26.9, matching go.mod.
  • README.md:81-83 scopes the README to the CLI and links the platform repo.
  • Neither file says go install .../cmd@latest any more.

Evidence

  • An independent non-author reviewer (sonnet, high) checked every claim in the issue against origin/main, then reviewed the diff in two passes. One low finding, about the provider items, was applied verbatim. The final check had no actionable findings at cfabc29.
  • markdownlint and the other pre-commit hooks pass.

🤖 Generated with Claude Code

CONTRIBUTING.md still listed platform-owned work (web dashboard,
Terraform/CloudFormation integration, API documentation) and provider
implementations that live in cloud-commitments-go as contribution areas
for this repo. Point those at the owning repos. The issue's Go-version and
README-scope findings were already fixed on main.

Closes #1177

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cristim cristim added priority/p3 Polish / idea / may never ship severity/low Minor harm urgency/eventually No deadline impact/internal Team-internal only effort/s Hours type/docs Documentation triaged Item has been triaged labels Oct 16, 2026
@coderabbitai

coderabbitai Bot commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

  • Run on-demand review

This review includes 1 billable file and costs up to $0.25.

  • Ask an admin to make reviews automatic

Open in CodeRabbit

Reviews can continue after your included limit without a manual trigger. An admin must approve usage-based billing.

Or wait 55 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available. Your 64 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: LeanerCloud/cloud-commitments-cli/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: f7c105be-6ee0-4677-9c58-73acf301b298
📥 Commits

Reviewing files that changed from the base of the PR and between e8543f0 and cfabc29.

📒 Files selected for processing: 1
  • CONTRIBUTING.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@cristim

cristim commented Oct 16, 2026

Copy link
Copy Markdown
Member Author

Independent review verdict: CLEAN at cfabc29

Reviewer: fresh Claude agent (Sonnet, high effort), not the author. Coordinator: claude-cc-reviewer.

What was checked:

  • The new links and the cmd/, docs/, scripts/, go.mod and Makefile paths exist in the repo.
  • The text agrees with README.md:79-83 and CONTRIBUTING.md:201/207/218.
  • No stale web UI, REST API, Terraform or CloudFormation areas remain. The one remaining platform mention (CONTRIBUTING.md:287) is a legitimate cross-repo reference.
  • markdownlint v0.47.0 (the pinned version) passes.

Gate:

@cristim
cristim merged commit 26c660b into main Oct 16, 2026
12 checks passed
@cristim
cristim deleted the docs/contributing-cli-scope branch October 16, 2026 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

effort/s Hours impact/internal Team-internal only priority/p3 Polish / idea / may never ship severity/low Minor harm triaged Item has been triaged type/docs Documentation urgency/eventually No deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HYG-08: README/CONTRIBUTING describe a CLI-only project on Go 1.23; web platform and Go 1.25 absent or contradicted

1 participant