Skip to content

DISCUSSIONS.md

Latest commit

 

History

History
136 lines (87 loc) · 4.45 KB

DISCUSSIONS.md

File metadata and controls

136 lines (87 loc) · 4.45 KB

GitHub Discussions Guide

Welcome to FlowFi's GitHub Discussions! This is the place for community conversations, questions, and ideas.

Overview

GitHub Discussions is our community forum for topics that don't fit neatly into Issues. We use it to keep Issues focused on actionable work while providing a space for broader conversations.

When to Use Discussions vs Issues

Use Discussions for:

  • ❓ Questions - How do I use this feature? How do I set it up?
  • 💡 Ideas & Feature Requests - Suggestions for improvements or new features
  • 🎉 Show and Tell - Share projects, demos, or interesting use cases
  • 📚 Best Practices - Advice on how to use FlowFi effectively
  • 🤔 General Feedback - Thoughts on the project direction

Use Issues for:

  • 🐛 Bug Reports - Something isn't working as expected.
  • ✨ Feature PRs - Implementation work and code changes
  • 📝 Documentation Tasks - Concrete docs or examples that need writing
  • 🔧 Refactoring Tasks - Code improvements with clear objectives

Discussion Categories

📋 Q&A

For questions about using, deploying, or understanding FlowFi.

Examples:

  • "How do I stream tokens to multiple recipients?"
  • "What's the minimum amount required to start a stream?"
  • "How does the event indexing work?"

💭 Ideas

For proposing and discussing new features or improvements.

Examples:

  • "Should we support batch stream creation?"
  • "Feature idea: Stream pause/resume functionality"
  • "Proposal: API improvements for stream management"

🎪 Show and Tell

Share projects, integrations, or interesting use cases you've built with FlowFi.

Examples:

  • "I built a salary payment dashboard using FlowFi"
  • "Integration: FlowFi + Ledger notifications"
  • "Demo: Real-time payment analytics"

Getting Started with Discussions

Asking a Question

  1. Go to FlowFi Discussions
  2. Click "New discussion"
  3. Select the Q&A category
  4. Search first to see if your question has already been answered
  5. Provide context: what you're trying to do, what you've already tried, and any error messages

Sharing an Idea

  1. Go to FlowFi Discussions
  2. Click "New discussion"
  3. Select the Ideas category
  4. Describe the idea clearly and explain the problem it solves
  5. Link to related discussions or issues if applicable

Showing Your Work

  1. Go to FlowFi Discussions
  2. Click "New discussion"
  3. Select the Show and Tell category
  4. Include a description, screenshots/demos, and a link to your project
  5. Include a brief explanation of how it uses FlowFi

Community Guidelines

  • Be Respectful: Treat all community members with respect and kindness
  • Search First: Before asking, search to see if your question has been answered
  • Provide Context: The more details you provide, the better help you'll receive
  • Stay On Topic: Keep discussions focused on FlowFi and related topics
  • No Spam: Self-promotion should be relevant and not excessive
  • Report Issues: If you find a bug, create an Issue instead

How Discussions Influence Development

  • Popular Ideas: Ideas with significant community support are considered for future roadmap planning
  • Questions Drive Documentation: Common Q&A topics often lead to improved docs or guides
  • Community Feedback: We regularly review discussions to understand user needs
  • Moving to Issues: If a discussion results in concrete work, it may be converted to an Issue

Helpful Resources

  • 📖 README - Project overview and getting started
  • 🤝 CONTRIBUTING - How to contribute code
  • 🏗️ ARCHITECTURE - System design and components
  • 🔒 SECURITY - Security policies and reporting

Have Questions About Discussions?

If you're unsure whether to open a Discussion or Issue, ask yourself:

  • Is it a concrete bug or task? → Open an Issue
  • Is it a question or idea? → Start a Discussion

Still unsure? Feel free to start a Discussion in Q&A—our community will guide you!

Happy discussing! 🚀