CONTRIBUTING.md

Contributing to pgflow

Thanks for your interest in pgflow! 🎉

Best Ways to Contribute

The most valuable contributions right now are:

• Use pgflow and spread the word 📢 - Share on social media, tell colleagues, write blog posts
• Report bugs via GitHub Issues
• Share feedback on Discord or GitHub Discussions
• Improve docs - typos, clarity, examples

Helping people discover pgflow is incredibly valuable!

Before Contributing Code

pgflow has ongoing development and planned features. To avoid duplicate or conflicting work:

1. Join Discord - Discuss your idea first
2. Open an issue - Get feedback before investing time
3. Start a discussion - For bigger ideas or questions

This is especially important for SQL/schema changes, which may conflict with upcoming work and require complex setup.

Fork PR Limitations

Forks don't have access to repository secrets, so CI may fail for database-related changes. Test locally and mention it in your PR.

Code Style

• Follow existing patterns in the codebase
• Run pnpm nx lint <package> before committing
• See .claude/ directory for detailed guidelines

Questions?

• Quick questions: Discord
• Bug reports: GitHub Issues
• Feature ideas: GitHub Discussions

Thanks for helping make pgflow better! 🚀