Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (75 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

120 lines (75 loc) · 3.01 KB
Raw

Contributing

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

Getting Started

Prerequisites

  • Ruby 3.0+
  • Bundler

Installation

Install the project dependencies:

bundle install

Building

Build the gem:

gem build *.gemspec

Testing

Run the test suite:

bundle exec rspec

Linting and Formatting

Check code style:

bundle exec rubocop

Fix code style issues:

bundle exec rubocop -a

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:

  • lib/ - API client classes and types
  • Most Ruby 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 Ruby SDK generator lives in the Fern repository
  2. Generator code is located at generators/ruby-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: bundle exec rspec
  4. Run linting: bundle exec rubocop
  5. Build the gem: gem build *.gemspec
  6. Commit your changes with a clear commit message
  7. 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 RuboCop for code formatting. Run bundle exec rubocop 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.