Contributing

Development Setup

bash# Clone repository
git clone https://github.com/ayush78490/Go-Predix.git
cd Go-Predix/gopredix-sdk

# Install development dependencies
go mod download
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

# Run tests
go test ./...

# Run linter
golangci-lint run ./...

# Generate documentation
godoc -http=:6060

Running Tests

bash# Run all tests
go test ./...

# Run with coverage
go test -cover ./...

# Run specific test
go test -run TestMarketCreation

Code Standards

  • Follow GoPredix conventions and idioms

  • Use meaningful variable and function names

  • Write comments for exported identifiers

  • Implement examples for public functions

  • Keep functions focused and small

Submitting a PR

  1. Fork the repository

  2. Create feature branch: git checkout -b feature/your-feature

  3. Make changes and add tests

  4. Ensure all tests pass: go test ./...

  5. Commit with clear message

  6. Push and submit PR with description


Support & Resources


License

GoPredix SDK is licensed under the MIT License. See LICENSE file for details.


Last Updated: December 2025

Last updated