1.8 KiB
1.8 KiB
Contributing to ComfyUI TK3R Extensions
Thank you for considering contributing to ComfyUI TK3R Extensions! This document provides guidelines for contributing to the project.
How to Contribute
Reporting Bugs
If you find a bug, please open an issue on GitHub with:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Your environment (OS, Python version, ComfyUI version)
- Screenshots if applicable
Suggesting Enhancements
Enhancement suggestions are welcome! Please open an issue with:
- A clear, descriptive title
- Detailed description of the proposed functionality
- Why this enhancement would be useful
- Examples of how it would be used
Pull Requests
- Fork the repository
- Create a new branch (
git checkout -b feature/amazing-feature) - Make your changes
- Ensure your code follows the existing style
- Test your changes thoroughly
- Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Code Style
- Follow PEP 8 guidelines
- Use meaningful variable and function names
- Add comments for complex logic
- Include docstrings for functions and classes
- Keep functions focused and concise
Testing
- Test your changes with different ComfyUI workflows
- Ensure backward compatibility when possible
- Document any breaking changes clearly
Documentation
- Update the README.md if you add new features
- Add usage examples for new nodes
- Update the changelog
Code of Conduct
- Be respectful and constructive
- Welcome newcomers and help them learn
- Focus on what is best for the community
- Show empathy towards other community members
Questions?
Feel free to open an issue for questions or join the discussion in existing issues.
Thank you for contributing! 🎉