Contributing to Spout
The spout project is open source and welcomes contributions from the community. There are many ways to contribute to the project, especially if for developers interested in python, autohotkey, or prompt engineering. The workspace's gitignore file follows a deny-first pattern, so you can add files to the project without worrying about conflicts when you pull the latest changes.
Ways to Contribute
- Custom Configurations: Create .txt/.ini files for core modules options config
- translation specifications as txt files for the translate module
- primer text files for the converse module
- Spoutlet Templates: Develop custom spoutlets for the core modules
- Prompt.txt files for the prompt template
- config.json files for the options config
- Code Improvements: Enhance Spout's core functionality and modules
- New transformer operations for text processing
- Addon modules for specialized workflows
- Automation scripts for chaining operations
- Testing & Quality: Help ensure Spout's reliability
- Test cases for new features
- Performance comparisons between LLM models
- Bug reports with detailed reproduction steps
- Documentation: Improve user guides and technical documentation
- Tutorials for common use cases
- Suggest improvements to this documentation site
- Documentation translations
- Community Support: Engage with and help grow the community
- Share custom spoutlets in the community hub
- Help users troubleshoot issues in Discord
- Suggest improvements to project organization
Spout welcomes contributions at all skill levels, from simple text configurations to complex module development. This inclusive approach helps the project grow as a flexible, community-driven framework for AI interaction.