🤝 How to Contribute to OmniScript

[alpha912]

Contributing to OmniScript 🤝

Want to contribute to OmniScript? We'd love your help! Here's how you can get involved.

🌟 Ways to Contribute

1. 📝 Code Contributions

Core Repositories:

• 🔧 Parser — Improve OSF parsing and validation
• 🔄 Converters — Add new export formats or improve existing ones
• ⌨️ CLI — Enhance command-line tools
• 🎨 VSCode Extension — Add features to the editor extension

Good First Issues: Look for good-first-issue labels!

2. 📚 Documentation

• Write tutorials and guides
• Improve API documentation
• Create video tutorials
• Translate documentation to other languages
• Fix typos and improve clarity

3. 🎨 Examples & Templates

Contribute to omniscript-examples:

• Create example documents
• Build templates for common use cases
• Share best practices
• Add test cases

4. 🐛 Bug Reports

Found a bug? Please report it!

Include:

• Clear description of the issue
• Steps to reproduce
• Expected vs actual behavior
• OSF snippet that causes the issue
• Environment (OS, Node version, package versions)

5. 💡 Feature Requests

Suggest new features in the Ideas discussion!

6. 🧪 Testing

• Test pre-release versions
• Write unit/integration tests
• Improve test coverage
• Test on different platforms (Windows, macOS, Linux)

7. 🌐 Community

• Answer questions in discussions
• Help newcomers get started
• Share your projects
• Write blog posts or create videos
• Spread the word on social media

🚀 Getting Started with Development

Setup

# Clone the repository
git clone https://github.com/OmniScriptOSF/omniscript-core.git
cd omniscript-core

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build
pnpm run build

Development Workflow

1. Fork the repository
2. Create a branch: git checkout -b feature/your-feature
3. Make changes and write tests
4. Run tests: pnpm test
5. Commit: Use Conventional Commits
   • feat: add new block type
   • fix: correct parsing error
   • docs: update API reference
6. Push and create a Pull Request

Code Style

• TypeScript with strict mode
• Follow existing code patterns
• Write tests for new features
• Document public APIs
• Keep PRs focused and atomic

📋 Contribution Guidelines

✅ DO:

• Follow the code style
• Write clear commit messages
• Add tests for new features
• Update documentation
• Be respectful and constructive

❌ DON'T:

• Submit PRs with unrelated changes
• Commit large files or binaries
• Break existing tests
• Skip documentation updates

🏆 Recognition

Contributors are:

• Listed in CONTRIBUTORS.md
• Credited in release notes
• Highlighted on our website
• Part of our community

💬 Questions?

Not sure where to start? Ask in this discussion!

We're here to help and excited to work with you! 🚀

📧 Contact

• 💬 Discussions: https://github.com/orgs/OmniScriptOSF/discussions
• 🐙 GitHub: https://github.com/OmniScriptOSF
• 🌐 Website: https://omniscriptosf.github.io

Thank you for making OmniScript better! ❤️