Skip to content

Commit

Permalink
More detailed instructions on creating an integration (zenml-io#639)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexejPenner authored May 24, 2022
1 parent adc83fd commit 5b54760
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,10 +194,20 @@ the most relevant places for contributors are highlighted with a `<-` arrow:
└── test <- Don't forget to write unit tests for your code
```

## 👷 Creating a new Integration

In case you want to create an entirely new integration that you would like to
see supported by ZenML check out the
[Integrations README](https://github.com/zenml-io/zenml/tree/main/src/zenml/integrations)
see supported by ZenML there are a few steps that you should follow:

1. Create the actual integration. Check out the
[Integrations README](src/zenml/integrations/README.md)
for detailed step-by-step instructions.
2. Create an example of how to use the integration. Check out the
[Examples README](examples/README.md)
to find out what to do.
3. All integrations deserve to be documented. Make sure to pay a visit to the
[Integrations Page](docs/book/advanced-guide/integrations/integrations.md)
in the docs and add the integration.

## 🆘 Getting Help

Expand Down

0 comments on commit 5b54760

Please sign in to comment.