Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

75 lines (55 loc) · 2.11 KB

Contributing to The Unreliable Narrator

Thank you for your interest in contributing! This project aims to combat misinformation through engaging, transparent, and accessible AI-powered fact-checking.

🌟 Our Mission

We believe that fighting misinformation requires:

  • Education over condescension - Teaching media literacy through engagement
  • Transparency over black boxes - Open-source AI that shows its work
  • Accessibility over paywalls - Free tools for everyone

🤝 How to Contribute

Reporting Bugs

  • Use GitHub Issues with the "bug" label
  • Include steps to reproduce, expected vs actual behavior
  • Add screenshots or console logs if applicable

Suggesting Features

  • Use GitHub Issues with the "enhancement" label
  • Explain the use case and societal impact
  • Consider how it aligns with our mission

Code Contributions

  1. Fork & Clone

    git clone https://github.com/pranshavpatel/hackncstate_unstable_diffusers.git
  2. Create a Branch

    git checkout -b feature/your-feature-name
  3. Make Changes

    • Follow existing code style
    • Add comments for complex logic
    • Test thoroughly (both modes: courtroom & fasttrack)
  4. Commit

    git commit -m "feat: add amazing feature"

    Use conventional commits: feat:, fix:, docs:, style:, refactor:

  5. Push & PR

    git push origin feature/your-feature-name

    Open a Pull Request with a clear description

🎯 Priority Areas

We especially welcome contributions in:

  • Accessibility: Screen reader support, keyboard navigation
  • Internationalization: Multi-language support
  • Performance: Faster analysis, reduced API costs
  • Education: Better "red flags" explanations
  • Mobile: Improved mobile experience

📝 Code of Conduct

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Assume good intentions
  • Remember: we're all fighting misinformation together

🙏 Recognition

All contributors will be acknowledged in our README and release notes.


Questions? Open a GitHub Discussion or reach out via Issues.