How to contribute
There are several ways you can contribute to the LFM Cookbook:Share your project
Built something with LFM? Add it to the community projects showcase
Improve documentation
Fix typos, clarify explanations, or add missing information
Add examples
Create new tutorials, notebooks, or code examples
Report issues
Found a bug or have a suggestion? Open an issue on GitHub
Submitting a community project
To add your project to the community projects showcase:Prepare your project
Ensure your project:
- Has a public GitHub repository
- Includes a clear README with setup instructions
- Uses LFM models or the LEAP SDK
- Works as described in the documentation
Fork the repository
Fork the LFM Cookbook repository on GitHub
Add your project
Edit the README.md file and add your project to the Community Projects section:Keep descriptions concise (under 100 characters) and informative
Open a pull request
Submit a pull request with:
- A clear title: “Add [Your Project Name] to community projects”
- Brief description of your project in the PR description
- Link to your GitHub repository
Improving documentation
To improve the cookbook documentation:Fork the repository
Fork the LFM Cookbook repository on GitHub
Make your changes
Edit the relevant files:
- Documentation pages are in the
docs/directory - Examples and tutorials are in the
examples/andfinetuning/directories - Use Markdown (.md or .mdx) for documentation files
Adding examples or tutorials
To contribute a new example or tutorial:Choose a category
Decide where your example fits:
examples/for ready-to-run applicationsfinetuning/notebooks/for training notebooksdocs/for documentation guides
Create your content
Follow the structure of existing examples:
- Include a clear README.md
- Add setup instructions and prerequisites
- Provide sample code and outputs
- Test thoroughly before submitting
Community standards
When contributing, please follow these guidelines:Code quality
Code quality
- Write clean, readable code with comments
- Follow existing code style and conventions
- Include error handling and edge cases
- Test your code before submitting
Documentation
Documentation
- Write clear, concise explanations
- Include setup instructions and prerequisites
- Add code comments for complex logic
- Use proper markdown formatting
Licensing
Licensing
- Ensure your contribution is your own work
- Respect existing licenses
- Don’t include proprietary or copyrighted code
Be respectful
Be respectful
- Be kind and constructive in discussions
- Welcome feedback and suggestions
- Help others in the community
- Follow the code of conduct
Getting help
Need help with your contribution?Join Discord
Ask questions and get help from the community
Documentation
Read the official Liquid AI documentation
Questions?
If you have questions about contributing, feel free to:- Ask in the Discord community
- Open an issue on GitHub for technical questions
- Review existing pull requests to see examples