Skip to content

Commit 17a9446

Browse files
committed
initial
1 parent 02568c7 commit 17a9446

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,29 @@ Please note that this project is released with a [Contributor Code of Conduct][c
1414

1515
**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](https://github.com/intercom/Intercom-OpenAPI/issues/new).
1616

17+
### Using Fern
18+
Our SDKs are generated from our OpenAPI spec using (Fern)[https://buildwithfern.com/learn/sdks/overview/introduction].
19+
If you making changes to the OpenAPI spec, you can use the Fern CLI to validate your changes and preview the impact on the generated SDKs. Here are some useful commands
20+
21+
Install fern: `npm install -g fern-api`
22+
23+
Validate the spec: `fern check`
24+
25+
Preview an sdk: `fern generate --preview --group`
26+
27+
You can find the appropriate group name in the (generators.yml)[./fern/generators.yml] file. For example `python-sdk` is the group name for the python sdk.
28+
29+
- Generate the Fern definition from the OpenAPI spec
30+
31+
`fern write-definition`
32+
33+
For more details on how to use the Fern CLI, refer to the Fern docs site or use the help commands integrated into the CLI.
34+
35+
`fern help`
36+
37+
`fern generate help`
38+
39+
1740
## Contributions to other files in the repository
1841

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

0 commit comments

Comments
 (0)