Files
s3-cli/CONTRIBUTING.md
Zach Kelling 0ba7019bf7 Rebrand: Hanzo S3 CLI -- remove all MinIO branding
- Replace copyright headers: "MinIO, Inc." -> "Hanzo AI, Inc." across 411+ Go files
- Replace "MinIO Object Storage stack" -> "Hanzo S3 stack" in all file headers
- Replace all user-facing "MinIO" references -> "Hanzo S3" in Usage, help text, examples
- Replace example alias "myminio" -> "mys3" throughout
- Replace example endpoints play.min.io -> s3.hanzo.ai, dl.min.io -> s3.hanzo.ai
- Replace doc URLs min.io -> hanzo.space
- Rewrite README.md/README_zh_CN.md: product is "Hanzo S3 CLI" (the s3 command)
- Update CONTRIBUTING.md, CONFLICT.md, NOTICE, code_of_conduct.md
- Update all Dockerfiles: labels, entrypoints, image refs -> ghcr.io/hanzos3/cli
- Update Makefile: build output, docker tags, install paths -> s3
- Update docker-buildx.sh: image tags -> ghcr.io/hanzos3/cli
- DO NOT change go.mod module path or import paths (github.com/minio/mc preserved)
- DO NOT change Go identifiers, SDK types, or wire protocol constants
- All unit tests pass
2026-02-21 14:19:07 -08:00

1.5 KiB

Setup your Hanzo S3 CLI Github Repository

Fork cli upstream source repository to your own personal repository.

$ git clone https://github.com/$USER_ID/cli
$ cd cli
$ make
$ ./s3 --help

Developer Guidelines

s3 welcomes your contribution. To make the process as seamless as possible, we ask for the following:

  • Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.

    • Fork it
    • Create your feature branch (git checkout -b my-new-feature)
    • Commit your changes (git commit -am 'Add some feature')
    • Push to the branch (git push origin my-new-feature)
    • Create new Pull Request
  • If you have additional dependencies for s3, s3 manages its dependencies using go mod

    • Run go get foo/bar
    • Edit your code to import foo/bar
    • Run GO111MODULE=on go mod tidy from top-level folder
  • When you're ready to create a pull request, be sure to:

    • Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
    • Run go fmt
    • Squash your commits into a single commit. git rebase -i. It's okay to force update your pull request.
    • Make sure make install completes.
  • Read Effective Go article from Golang project

    • s3 project is conformant with Golang style
    • if you happen to observe offending code, please feel free to send a pull request