Flytesnacks Contribution Guide#
First off, thank you for thinking about contributing! Below you’ll find instructions that will hopefully guide you through how to contribute to and improve Flytesnacks.
💻 Contribute to Examples#
Determine where to put your new code.
Core: Contains examples that demonstrate functionality available within core flytekit. These examples should be runnable locally.
Integrations: Contains examples that leverage one or more of the available plugins.
Case Studies: Contains examples that demonstrate the usage of Flyte to solve real-world problems. These are generally more complex examples that may require extra setup or that can only run on larger clusters.
Create a directory. (applicable for
After determining where to put your example, create a directory under the appropriate parent directory. Each example directory should contain:
It might be easier to copy one of the existing examples and modify it to your needs.
Add the example to CI.
Add the example to flyte_tests_manifest.json.
Test your code!
If the Python code can be run locally, just use
python <my file>to run it.
- If the Python code has to be tested in a cluster:
Install Flytectl by running
brew install flyteorg/homebrew-tap/flytectl. Learn more about installation and configuration of Flytectl here.
flytectl sandbox start --source=$(pwd)command in the directory that’s one level above the directory that has workflows.
For example, to register house price prediction example, run the start command in the
ml_trainingdirectory. To register
coreexamples, run the start command in the
cdto the required directory and run all the consequent commands in there!
- Following are the commands to run if examples in
coredirectory are to be tested on sandbox:
Build Docker container using the command:
flytectl sandbox exec -- docker build . --tag "core:v1" -f core/Dockerfile.
Package the examples by running
pyflyte --pkgs core package --image core:v1 -f.
Register the examples by running
flytectl register files --archive -p flytesnacks -d development --archive flyte-package.tgz --version v1.
Visit https://localhost:30081/console to view the Flyte console, which consists of the examples present in the
5. To fetch new dependencies and rebuild the image, run
flytectl sandbox exec -- docker build . --tag "core:v2" -f core/Dockerfile,
pyflyte --pkgs core package --image core:v2 -f, and
flytectl register files --archive -p flytesnacks -d development --archive flyte-package.tgz --version v2. 6. Refer to this doc if the code in itself is updated and requirements.txt is the same.
We use pre-commit to automate linting and code formatting on every commit. Configured hooks include black, isort, flake8 and linters to ensure newlines are added to the end of files, and there is proper spacing in files.
We run all those hooks in CI, but if you want to run them locally on every commit, run pre-commit install after installing the dev environment requirements. In case you want to disable pre-commit hooks locally, run pre-commit uninstall. More info here.
We use codespell to catch common misspellings. Run
make spellcheck to spell-check the changes.
📝 Contribute to Documentation#
docs folder in
flytesnacks houses the required documentation configuration. The core, case_studies, and integrations docs are written in the respective README.md and the Python code files.
README.md file needs to capture the what, why, and how.
What is the integration about? Its features, etc.
Why do we need this integration? How is it going to benefit the Flyte users?
Showcase the uniqueness of the integration
How to install the plugin?
Refer to any repo in the cookbook directory to understand this better.
Explain what the code does.
Update conf.py (imagine you have added
Add the Python file names to the
Add the code for panel and TOC in the required RST file.
Add the name and path to
.github/workflows/ghcr_push.ymlif you’re adding an integration or a tutorial.
Add an entry to cookbook/flyte_tests_manifest.json if you’re adding an integration or a tutorial.
Verify that the code and documentation look as expected.
Learn about the documentation tools here
Install the requirements by running
pip install -r docs-requirements.txtin the
make htmlin the
For implicit targets, run
make -C docs html.
Open the HTML pages present in the
docs/_builddirectory in the browser
After creating the pull request, ensure that the docs are rendered correctly by clicking on the documentation check.
You can refer to this PR for the exact changes required.