mirror of
https://github.com/pgsty/minio.git
synced 2026-08-09 15:53:28 +03:00
Feng Ruohang
c46b16ec62
The transitional references land in one commit, because they are only correct together: the repository is pgsty/silo, its default branch is main, and nothing in the tree should point a user at the old names. Changed: - Workflow branch filters. go.yml and vulncheck.yml gated on `branches: master` for both push and pull_request, so renaming the default branch would have taken automatic CI offline with no error and no signal - the workflows would simply never trigger again. They now name main. - Release target. goreleaser's `release.github.name` becomes silo, which is what actually decides where a tagged build publishes. sign-release-rpms.sh's GH_REPO default follows. - The OCI `image.source` label, the Helm chart `sources` entry, the security advisory link in the issue-template config, and the go.mod comment citing the LDAP TLS fix. - 115 occurrences across README, README_ZH, SECURITY, CONTRIBUTING and 30 docs pages, including 72 links that also carried the master branch in their path. Those matter most: GitHub redirects clone, fetch, push and web URLs after a rename, but raw.githubusercontent.com does not, and neither follows a branch rename - every one of those links would 404 twice over. - Three error strings in cmd/erasure-sets.go, cmd/storage-errors.go and internal/config/errors.go that print an issue URL to operators. These are Go string literals inside rebrand-guard's brand allowlist, so the baseline is regenerated. The regeneration removes exactly those three entries and adds none; all twelve other protected sets, including the 9014 exported symbols, are byte-identical. - The transitional-naming disclaimers in README, README_ZH, SECURITY and CONTRIBUTING are dropped, since they no longer describe anything. Deliberately unchanged, all three because they exist to reject or freeze the old name rather than to point at it: - buildscripts/minio-upgrade.sh pins pgsty/minio@sha256:b6bfe72... - the frozen pre-rebrand image is the control group for the MinIO-to-Silo upgrade test. - helm-migration-guard rejects any rendered container still pulling pgsty/minio. - verify-rebrand.sh rejects the same in the delivery surfaces. Also unchanged: docs/config/README.md links to pgsty/mc/blob/master, and that repository's default branch really is still master. It moves when mc does. verify-rebrand.sh gains three assertions so this cannot silently regress: no source reference may name pgsty/minio outside the three allowlisted guards, no link may target pgsty/silo's master branch, and go.yml and vulncheck.yml must filter on main. Both new rejections were negative-tested - reintroducing a master branch filter and adding a pgsty/minio URL each fail the gate with the specific message. This commit assumes the rename actually happens. Until the GitHub branch and repository renames are executed, the links it introduces do not resolve. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
93 lines
2.6 KiB
Markdown
93 lines
2.6 KiB
Markdown
# Contributing to Silo
|
|
|
|
Silo welcomes focused contributions that improve security, reliability,
|
|
compatibility, packaging, tests, or maintainability. This repository preserves
|
|
MinIO-compatible interfaces and storage formats, so changes must identify and
|
|
test any compatibility impact.
|
|
|
|
## Development Workflow
|
|
|
|
Fork the current Silo source repository, create a topic branch, and submit a
|
|
pull request. Discuss broad or compatibility-sensitive changes in an issue
|
|
before implementation.
|
|
|
|
### Set up a checkout
|
|
|
|
```sh
|
|
git clone https://github.com/pgsty/silo
|
|
cd silo
|
|
go build -o silo .
|
|
./silo --version
|
|
```
|
|
|
|
### Keep the lineage remote separate
|
|
|
|
```sh
|
|
git remote add lineage https://github.com/minio/minio
|
|
git fetch lineage
|
|
```
|
|
|
|
Do not merge an upstream branch into a pull request unless the maintainers have
|
|
agreed on the scope. Silo intentionally carries a small downstream delta.
|
|
|
|
### Create your feature branch
|
|
|
|
Create a separate branch before making code changes:
|
|
|
|
```
|
|
git checkout -b my-new-feature
|
|
```
|
|
|
|
### Test Silo server changes
|
|
|
|
Before opening a pull request:
|
|
|
|
- Add or update tests for changed behavior.
|
|
- Run `make verifiers`.
|
|
- Run the smallest relevant package tests, then `make test` when practical.
|
|
- Run `make build` and confirm the generated executable is `silo`.
|
|
- Explain any preserved `MINIO_*`, `minio_*`, `x-minio-*`, `/minio/*`,
|
|
`.minio.sys`, ARN, module/import-path, or serialized compatibility name.
|
|
|
|
### Commit changes
|
|
|
|
After verification, commit your changes with a concise message:
|
|
|
|
```
|
|
git commit -am 'Fix object replication retry handling'
|
|
```
|
|
|
|
### Push to the branch
|
|
|
|
Push your locally committed changes to the remote origin (your fork)
|
|
|
|
```
|
|
git push origin my-new-feature
|
|
```
|
|
|
|
### Create a Pull Request
|
|
|
|
Pull requests should include motivation, reproduction steps where applicable,
|
|
test evidence, compatibility notes, and documentation impact. Public product
|
|
documentation is owned by the separate
|
|
[`pgsty/silo.pgsty.com`](https://github.com/pgsty/silo.pgsty.com) repository.
|
|
|
|
## FAQs
|
|
|
|
### How does Silo manage dependencies?
|
|
|
|
Silo uses Go modules. Preserve the compatibility module and import paths in
|
|
`go.mod`; downstream forks are selected with explicit `replace` directives.
|
|
|
|
- Run `go get foo/bar` in the source folder to add the dependency to `go.mod` file.
|
|
|
|
To remove a dependency
|
|
|
|
- Edit your code and remove the import reference.
|
|
- Run `go mod tidy` in the source folder to remove dependency from `go.mod` file.
|
|
|
|
### What are the coding guidelines?
|
|
|
|
Follow the existing Go style, run `gofmt` on changed Go files, and keep changes
|
|
compact. See the Go project's [code review comments](https://go.dev/wiki/CodeReviewComments).
|