Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (69 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

98 lines (69 loc) · 2.13 KB

Contributing to GreenNode CLI

Getting Started

Prerequisites

  • Go 1.22 or later
  • Git

Setup development environment

git clone https://github.com/vngcloud/greennode-cli.git
cd greennode-cli/go
go build -o grn .
./grn --version

Build

cd go
CGO_ENABLED=0 go build -o grn .

Development Workflow

1. Create a feature branch

git checkout main && git pull
git checkout -b feat/your-feature-name

2. Make changes and build

cd go
# Write code
CGO_ENABLED=0 go build -o grn .
./grn vks <your-command> --help

3. Add a changelog entry

Every PR should include a changelog fragment:

./scripts/new-change -t feature -c vks -d "Add your feature description"

Change types: feature, bugfix, enhancement, api-change

4. Commit and push

Follow Conventional Commits:

feat(vks): add describe-events command
fix(auth): fix token refresh race condition
docs(readme): update installation instructions

5. Create a Pull Request

  • PR to main when release-ready
  • CI must pass before merge
  • At least 1 approval required

Adding a New Command

  1. Create go/cmd/vks/<command_name>.go
  2. Define cobra.Command with Use, Short, RunE
  3. Register in go/cmd/vks/vks.go: VksCmd.AddCommand(newCmd)
  4. Add validator.ValidateID() for any ID args
  5. Add --dry-run for create/update/delete
  6. Add --force + confirmation for delete
  7. Create docs/commands/vks/<command-name>.md — command reference page
  8. Add entry to docs/commands/vks/index.md table
  9. Add nav entry to mkdocs.yml

Adding a New Service

  1. Create go/cmd/<service>/ directory
  2. Create parent command with cobra.Command
  3. Register in go/cmd/root.go: rootCmd.AddCommand(serviceCmd)

Code Style

  • All source code text in English
  • Use cobra patterns for all commands
  • Validate user inputs (IDs used in URLs)
  • Use --dry-run for create/update/delete commands
  • Add --force to skip confirmation on delete commands

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.