Set|File Community
Join us in making data files readable again
Set files are an open community project. Everyone is welcome to participate, contribute, and help shape the future of the format.
How to Participate
Use Set Files
The best way to support the project is to use Set files in your own projects and share your experience.
Report Issues
Found a bug or unclear documentation? Report it on GitHub
Ask Questions
Need help? Have ideas? Start a discussion
Contribute Code
Write a parser, create examples, improve documentation. See contributing guidelines?
Ways to Contribute
Parser Implementations
We need Set file parsers in many languages. Current status:
Available:
- JavaScript/Node.js - Full v4.0 support
In Progress:
Wanted:
- Ruby
- PHP
- Java
- C#
- Go
- Rust
- Swift
- And more!
Guidelines for parser contributions →?
Example Files
Share your Set file examples:
- Real-world use cases
- Creative applications
- Best practices demonstrations
- Edge cases and testing
How to submit examples →?
Documentation
Help improve the documentation:
- Fix typos and clarify explanations
- Add more examples
- Translate to other languages
- Create tutorials and guides
Documentation guidelines →?
Testing & Validation
Help ensure quality:
- Test parsers with edge cases
- Validate specification compliance
- Create test suites
- Report bugs and inconsistencies
Community Resources
GitHub Repository
github.com/kirksiqveland/setfile
- Source code for parsers
- Documentation source (Markdown)
- Issue tracking
- Pull requests
Discussions
GitHub Discussions
- Ask questions
- Share ideas
- Propose new features
- General conversation
Issue Tracker
GitHub Issues
- Bug reports
- Feature requests
- Documentation issues
Contributing Guidelines
Before contributing, please read:
Recognition
Contributors are recognized in:
- README.md contributors section
- Release notes for their contributions
- Documentation credits
All contributors retain copyright to their work while licensing it for use in the project.
Project Governance
Set files are maintained by Kirk Siqveland with input from the community.
- Specification decisions: Proposed in GitHub discussions, decided by maintainer
- Parser implementations: Maintained by their respective authors
- Documentation: Community contributions reviewed and merged by maintainer
Communication
Primary Channels
- GitHub Discussions: For questions, ideas, general discussion
- GitHub Issues: For bugs and specific problems
- Email: kirk@setfiles.org for direct contact
Response Times
- Issues and PRs: Typically within 1-2 days
- Discussions: As available (usually daily)
- Email: Within 2-3 days
Roadmap
Current priorities:
Short Term
- Python parser implementation
- More example files
- Tutorial videos/content
- Syntax highlighting for popular editors
Medium Term
- Parser libraries in additional languages
- SetQL implementation examples
- Performance benchmarking
- Migration tools from other formats
Long Term
- Native editor support
- IDE integrations
- Schema validation tools
- Format converters
Discuss the roadmap
Success Stories
Using Set files in your project? We'd love to hear about it!
- Share your use case in discussions
- Submit to be featured on this page
- Help others learn from your experience
Code of Conduct
We are committed to providing a welcoming and inclusive environment for everyone.
Key principles:
- Be respectful - Different viewpoints and experiences are valuable
- Be constructive - Critique ideas, not people
- Be collaborative - We're all here to learn and improve
- Be patient - Everyone was new once
Read full Code of Conduct →?
Getting Started
New to contributing? Start here:
- Read the docs: Quick Start and Specification
- Try Set files: Create some files, test a parser
- Find an issue: Look for "good first issue" labels on GitHub
- Ask questions: Don't hesitate to ask in discussions
- Submit your work: Open a pull request
Full contributing guide →?
Contact
← Back to Home
