Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (28 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.24 KB

🤝 Contributing to RepoSync

First off, thank you for considering contributing to RepoSync! Let's get stuck in and develop this!

🛠️ How Can I Contribute?

🐛 Reporting Bugs

  • Use the GitHub Issues tab.
  • Describe the bug and include steps to reproduce it.
  • Mention your Python version (3.13 preferred) and Reflex version.

✨ Suggesting Enhancements

  • Open an issue with the tag enhancement.
  • Explain why this feature would be useful to other developers.

⌨️ Pull Requests (PRs)

  1. Fork the repository.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

📜 Style Guide

  • Code Style: Fllow PEP 8 standards.
  • Reflex Best Practices:
    • Keep the State clean and documented.
    • Use rx.vstack and rx.hstack for layout consistency.
    • Always use Computed Vars (@rx.var) for derived data.

⚖️ Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

Happy Coding! 😁