diff --git a/README.md b/README.md index c19f1e08b..6d092838f 100644 --- a/README.md +++ b/README.md @@ -42,39 +42,33 @@ Here are the setup instructions to start contributing to `flytesnacks` repo: ### 💻 Contribute to examples 1. Determine where to put your new code: - * [Core](https://github.com/flyteorg/blob/master/cookbook/core) - - Contains examples that demonstrates functionality available within core flytekit. These examples should be runnable - locally. - - * [Integrations](https://github.com/flyteorg/blob/master/cookbook/integrations) - - Contains examples that leverage one or more of the available plugins. - - * [Case Studies](https://github.com/flyteorg/blob/master/cookbook/case_studies) - - Contains examples that demonstrates usage of Flyte to solve real world problems. These are more generally more complex - examples that may require extra setup or that can only run on larger clusters.. - + * [Core](https://github.com/flyteorg/blob/master/cookbook/core) + + Contains examples that demonstrates functionality available within core flytekit. These examples should be runnable + locally. + + * [Integrations](https://github.com/flyteorg/blob/master/cookbook/integrations) + + Contains examples that leverage one or more of the available plugins. + + * [Case Studies](https://github.com/flyteorg/blob/master/cookbook/case_studies) + + Contains examples that demonstrates usage of Flyte to solve real world problems. These are more generally more complex + examples that may require extra setup or that can only run on larger clusters. + 2. Create a directory - After determining where to put your example, create a directory under the appropriate parent directory. Each example directory should contain: - * Dockerfile * Makefile * README.rst * __init__.py * requirements.in * sandbox.config - It might be easier to copy one of the existing examples and modify it to your needs. - 3. Add it to CI - Examples are references in [this github workflow](https://github.com/flyteorg/flytesnacks/blob/master/.github/workflows/ghcr_push.yml) Add a new entry under ``strategy -> matrix -> directory`` with the name of your directory as well as its relative path. - 4. Test your code! * If the Python code can be run locally, just use `python ` to run it. * If the Python code has to be tested in a cluster: