English Version | 中文版本

Repository: https://github.com/zte-riscv/go

This specification applies to the Go RISC-V code repository jointly maintained by ZTE and ByteDance. We are committed to enhancing Golang support for RISC-V architecture, regularly contributing code upstream to golang/go while synchronizing with its latest features.

We warmly welcome community developers to participate! Whether it's fixing bugs, implementing new features, or improving documentation, your contributions will help advance the RISC-V ecosystem.

To ensure efficient collaboration, please review the following guidelines before submitting code:

Mandatory:

• Create or claim a related Issue before commencing substantive work
• Clearly describe the change motivation, design approach, and expected impact in the Issue

Recommended:

• For significant changes (e.g., new instruction set support, architectural modifications), submit a design document for prior review

# Create a feature branch from the current development branch (e.g., go1.25.3-zte-dev): git fetch origin git checkout -b your_dev_branch origin/go1.25.3-zte-dev

Issue Submission:

• For bug reports: Document the problem, environment, and reproduction steps
• For features/optimizations: Describe the technical background and implementation strategy

Pull Request Submission:

• Provide task context in the PR description and reference related Issues
• Resolve all merge conflicts locally before submission

CI and Review:

• Automated test suites will execute upon PR submission (failed tests block merging)
• Require approvals from designated reviewers before merging, reviewers comment +1 or +2.

Merge Policy:

• All commits must be squashed into a single commit

For squashed commits, follow this format:

git commit -m "package: concise change summary  Fixes #12345 Updates #67890"

• Header: Package prefix + brief description (<50 chars)
• Footer: Issue references

• CI pipeline must pass
• Minimum approvals:
• One +2 from ZTE core maintainers
• One +2 from ByteDance core maintainers

• +1: Preliminary approval (requires additional reviewer)
• +2: Final approval for merging

For maintainers and reviewers: when approving the merge, please respond with either +1 or +2.

• ✅ Go coding standards compliance
• ✅ Passing CI pipelines
• ✅ Corresponding test coverage
• ✅ Performance benchmarks (where applicable)

• Static Analysis: Run go vet on all modified code packages
• Codegen Validation: Verify RISCV64 instruction generation via asmcheck (go/test/codegen/)
• Assembly Tests: Validate machine code output from assembly instructions (go/src/cmd/asm/internal/asm/testdata/riscv64.s)
• Regression Testing: Execute go/src/all.bash on x86/ARM architectures
• Application Testing: Validate test file execution in QEMU-RISCV environment (go/test/zte/*_test.go)

For performance-sensitive changes:

Test Environment:

- Hardware: [e.g., SiFive Unmatched, VisionFive2] - Go Version: - Test Date: - CPU (Optional): [Cores, frequency, RISC-V extensions] - Memory (Optional):

Benchmark Results, benchstat comparison:

benchstat old.txt new.txt name old time/op new time/op delta Fibonacci 125ms ± 2% 98ms ± 3% -21.60% (p=0.000 n=10+10) Sort 456ms ± 1% 401ms± 2% -12.06% (p=0.000 n=9+10) 

Official Go Contribution Guide: https://golang.org/doc/contribute