Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (31 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 1.16 KB

Contributing

Thanks for contributing to Awesome Knative Function Templates!

Adding a New Template

1. Create the template directory

Place your template under the matching language directory:

<language>/<template-name>/

Supported languages: go, node, python, quarkus, rust, springboot, typescript.

Follow the conventions of existing templates in the same language for project structure, build files, and function signatures.

2. Verify it works

Your template must work with the func CLI:

func run --builder=host

Add tests and make sure they pass.

3. Write a README

Add a README.md inside your template directory covering:

  • What the function does
  • Any prerequisites (e.g. Ollama server, external services)
  • How to run and deploy
  • Example usage
  • How to run tests

4. Update the template indexes

Add your template to both index files so users and agents can discover it:

  • README.md — add a line under the correct language heading
  • AGENTS.md — add a line under the matching language heading

5. Open a pull request

Push your branch and open a PR. Make sure your template builds and tests pass.