Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (53 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 1.77 KB
Raw

Contributing

Thanks for contributing to app-store-connect-cli.

Goals

This project tries to stay:

  • easy to use for app developers
  • predictable for LLMs and automation
  • maintainable as a hand-written Go CLI

When contributing, prefer small, explicit changes over broad abstractions.

Development Setup

git clone https://github.com/techinpark/app-store-connect-cli.git
cd app-store-connect-cli
go test ./...
go build ./...

Contribution Guidelines

  • keep command names and JSON output stable unless there is a strong reason to change them
  • prefer adding focused first-class commands for high-value workflows
  • use asc raw as the escape hatch instead of over-engineering generic wrappers
  • avoid adding heavy code generation unless it materially improves maintainability
  • keep error messages concise and actionable
  • add tests for new command paths, client logic, and decoding logic

Pull Requests

Please include:

  • what changed
  • why it changed
  • how you tested it
  • whether the change affects CLI output, command names, or automation behavior

Good PRs for this repository are usually:

  • narrowly scoped
  • operationally useful
  • covered by tests

Code Style

  • use standard Go formatting
  • keep Cobra command code thin
  • put App Store Connect request and decoding logic under internal/appstore
  • prefer deterministic JSON structures for machine-readable output

Suggested Workflow

go test ./...
go test ./... -cover
go build ./...

If you add or change a command:

  • update README.md
  • update LLM_GUIDE.md when the change affects automation usage

Reporting Issues

Open a GitHub issue with:

  • the command you ran
  • whether you used --json
  • the relevant App Store Connect resource type
  • the exact error output
  • the expected behavior