Skip to content

Latest commit

 

History

History
99 lines (66 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

99 lines (66 loc) · 3.28 KB

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributions to the OpenAPI descriptions

We don't currently accept pull requests that directly modify the description artifacts found in this repository. If you have feedback on the descriptions or have found a mismatch between the behavior that is described in this repo and the runtime behavior of the API, please open an issue.

Using Fern

Our SDKs are generated from our OpenAPI spec using Fern.

If you're making changes to the OpenAPI spec, you can use the Fern CLI to validate your changes and preview the impact on the generated SDKs.

Installation

npm install -g fern-api

Common Commands

Validate the spec:

fern check

Preview an SDK:

fern generate --preview --group <group-name>

⚠️ Important Warning

Be careful not to run fern generate without the --preview flag in your local development environment!

Running fern generate without the preview flag will automatically submit pull requests to the SDK's GitHub repository. This command is intended for use in CI/CD pipelines only.

❌ Don't do this locally:

fern generate --group <group-name>

✅ Always use preview mode for local development:

fern generate --preview --group <group-name>

Note: You can find the appropriate group name in the generators.yml file. For example, python-sdk is the group name for the Python SDK.

Generate the Fern definition from the OpenAPI spec:

fern write-definition

Help Commands

Get general help:

fern help

Get help for the generate command:

fern generate help

Additional Resources

For more details on how to use Fern, refer to the documentation for:

Contributions to other files in the repository

We will gladly accept pull requests for contributions to other files in this repository.

Submitting a pull request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change
  4. Push to your fork and submit a pull request
  5. Pat your self on the back and wait for your pull request to be reviewed and merged.

Resources