Getting Help

Need assistance with Spry? We’re here to help! This page outlines the various ways you can get support, report issues, or connect with the Spry community.

Quick Links

• GitHub Issues - Report bugs or request features
• GitHub Discussions - Ask questions and share ideas
• Discord Community - Chat with other users and contributors

Reporting Issues

If you’ve encountered a bug or unexpected behavior:

1. Search existing issues - Check if someone has already reported the problem
2. Gather information - Note your Spry version, Deno version, operating system, and steps to reproduce
3. Create a detailed report - Include:
   • Clear description of the issue
   • Steps to reproduce
   • Expected vs actual behavior
   • Relevant Markdown code snippets or Spryfile.md examples
   • Error messages or logs
   • Screenshots if applicable

Report a bug →

Feature Requests

Have an idea to improve Spry?

1. Check existing feature requests
2. Start a discussion to gather feedback
3. Submit a formal feature request

Getting Support

GitHub Discussions

For questions, ideas, and community support, use GitHub Discussions:

• Q&A - Ask questions about using Spry
• Ideas - Share suggestions and discuss potential features
• Show and Tell - Share what you’ve built with Spry
• General - Everything else related to Spry

Community Chat

Join our Discord server for real-time conversations:

• Get quick answers to questions
• Share tips and tricks
• Connect with other Spry users
• Stay updated on development

Documentation

Before asking for help, check if your question is answered in:

• Getting Started Guide
• API Reference
• Examples
• FAQ

Common Issues

Installation Problems

If you’re having trouble installing Spry:

# Ensure you have Deno 2.5+ installed
deno --version

# Run Spry initializer
cd <your-project>
deno run --node-modules-dir=auto -A https://raw.githubusercontent.com/programmablemd/spry/main/lib/sqlpage/cli.ts init

Spryfile.md Not Executing

Make sure your code blocks have the correct language identifiers and attributes:

```sql {.store-result}
SELECT * FROM users;
```

SQLPage Integration Issues

For SQLPage-related problems:

• Verify your sqlpage/sqlpage.json configuration
• Check that dev-src.auto/ directory is being generated
• Ensure database connection strings are correct

Performance Issues

For large Markdown files or complex workflows:

• Break content into smaller, focused Spryfile.md documents
• Use task dependencies efficiently
• Monitor execution with --watch during development

Security Issues

If you discover a security vulnerability, please do not open a public issue. Instead:

1. Email security@programmablemd.org with details
2. Allow us time to address the issue
3. We’ll credit you in the security advisory (if desired)

See our Security Policy for more information.

Contributing

Want to help improve Spry? See our Contributing Guide to learn how to:

• Set up your development environment
• Submit pull requests
• Follow our coding standards
• Join the core contributor team

Response Times

We’re a community-driven project. Expected response times:

• Critical bugs - Within 24-48 hours
• General issues - Within 1 week
• Feature requests - Varies based on complexity and priority
• Community discussions - Community members typically respond within hours

Additional Resources

• Changelog - See what’s new
• Roadmap - View planned features
• Blog - Read articles and announcements
• Twitter - Follow for updates

Still Need Help?

If you can’t find what you’re looking for:

1. Search our documentation
2. Check GitHub Discussions
3. Ask in our Discord community
4. Open a GitHub issue as a last resort

Thank you for being part of the Spry community!