Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
143 lines (90 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

143 lines (90 loc) · 3.81 KB
Raw

Contributing

Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.

Getting Started

Prerequisites

  • Go 1.21+
  • Docker (only required to run wire tests; see Wire Tests)

Installation

Install the project dependencies:

go mod tidy

Building

Build the project:

go build ./...

Testing

Run the test suite:

go test ./...

Wire Tests

If this SDK includes a wiremock/ directory, the test suite contains wire tests that exercise the client against a WireMock server. The go test command above expects WIREMOCK_URL to point at a running WireMock instance.

Start WireMock, run the tests, then tear it down:

docker compose -f wiremock/docker-compose.test.yml up -d
export WIREMOCK_URL=http://localhost:$(docker compose -f wiremock/docker-compose.test.yml port wiremock 8080 | cut -d: -f2)
go test ./...
docker compose -f wiremock/docker-compose.test.yml down

The compose file maps WireMock's container port 8080 to a random host port, which is why WIREMOCK_URL is derived from docker compose ... port rather than hardcoded.

Formatting

Format code:

gofmt -w .

Or equivalently:

go fmt ./...

Vetting

Run the Go vet tool to catch common mistakes:

go vet ./...

About Generated Code

Important: Most files in this SDK are automatically generated by Fern from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.

Generated Files

The following directories contain generated code:

  • Most Go files in the project

How to Customize

If you need to customize the SDK, you have two options:

Option 1: Use .fernignore

For custom code that should persist across SDK regenerations:

  1. Create a .fernignore file in the project root
  2. Add file patterns for files you want to preserve (similar to .gitignore syntax)
  3. Add your custom code to those files

Files listed in .fernignore will not be overwritten when the SDK is regenerated.

For more information, see the Fern documentation on custom code.

Option 2: Contribute to the Generator

If you want to change how code is generated for all users of this SDK:

  1. The Go SDK generator lives in the Fern repository
  2. Generator code is located at generators/go-v2/
  3. Follow the Fern contributing guidelines
  4. Submit a pull request with your changes to the generator

This approach is best for:

  • Bug fixes in generated code
  • New features that would benefit all users
  • Improvements to code generation patterns

Making Changes

Workflow

  1. Create a new branch for your changes
  2. Make your modifications
  3. Run tests to ensure nothing breaks: go test ./...
  4. Format your code: gofmt -w .
  5. Vet your code: go vet ./...
  6. Build the project: go build ./...
  7. Commit your changes with a clear commit message
  8. Push your branch and create a pull request

Commit Messages

Write clear, descriptive commit messages that explain what changed and why.

Code Style

This project uses gofmt for code formatting. Run gofmt -w . before committing to ensure your code meets the project's style guidelines.

Questions or Issues?

If you have questions or run into issues:

  1. Check the Fern documentation
  2. Search existing GitHub issues
  3. Open a new issue if your question hasn't been addressed

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.