Thank you for your interest in contributing to this project! Here's how you can help.
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
- Check if the bug has already been reported in the Issues section
- Include a clear title and description
- Provide a minimal working example that reproduces the issue
- Specify your Typst version (
typst --version)
- Check if the enhancement has already been suggested
- Include a clear title and description
- Explain why this enhancement would be useful
- Provide examples of how it would be used
- Fork the repository
- Create a new branch for your feature or bugfix
- Make your changes
- Test compilation with
typst compileto ensure your changes work - Submit a pull request
- Use consistent indentation (2 spaces)
- Follow Typst naming conventions for functions and variables
- Include comments for complex code sections
- Use parameters and variables instead of hardcoded values
- Update documentation for any changed functionality
- Include examples in documentation
- Document any new functions or features with their parameters
- Use clear, concise language
- Templates should be minimal and well-documented
- Include example usage in comments
- Ensure templates compile without errors with latest Typst
- Don't include unnecessary dependencies
- Provide test documents that demonstrate your changes
- Ensure your changes compile with
typst compile - Test templates with different content types (text, math, figures, etc.)
Feel free to open an issue for any questions about contributing. We're happy to help!