Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (43 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 2.52 KB

Contributing

Thank you for your interest in contributing to StreamFi! Before making any changes, please discuss the modifications you wish to make via an issue, email, or any other method with the repository owners to ensure alignment with the project's vision.

💬 Connect With Us

For any queries about contributing, feel free to join our Telegram group.

🛠 Development Environment Setup

To set up a local development environment, follow these steps:

git clone https://github.com/StreamFi-x/streamfi-frontend.git
cd streamfi
npm install && npm run dev

🚀 Issues and Feature Requests

Issues labeled open for contribution are specifically available for community contributions. If you're interested in helping, please focus on these issues.

All tasks must be completed by the stated deadline in the issue description. Failure to meet the deadline may result in reassignment or a reduction in any potential rewards.

📌 Creating an Issue

Found a bug or have a feature suggestion? Help us improve StreamFi by submitting an issue on GitHub. Before creating an issue, please search the existing issue archive to check if it's already reported.

A good issue report should be:

  • Reproducible: Include steps to reproduce the problem.
  • Specific: Provide as much detail as possible (version, environment, etc.).
  • Unique: Avoid duplicate issues.
  • Scoped: Keep each issue focused on a single bug or feature.

Even better—submit a pull request with a fix or implementation!

🔀 How to Submit a Pull Request

  1. Search the repository for open or closed Pull Requests related to your submission to avoid duplicate efforts.
  2. Fork the project.
  3. Create your feature branch: 
    git checkout -b feat-45-streaming-bug
  4. Commit your changes: 
    git commit -m 'feat: add streaming-bug'
  5. Push to the branch: 
    git push origin feat-45-streaming-bug
  6. Open a Pull Request on GitHub.

🏷 Understanding Pull Request Labels

  • Ready for Review: PR is complete and awaiting review.
  • In Progress – Do Not Merge: PR is still being worked on.
  • Changes Requested: Maintainers have reviewed and requested modifications. Once addressed, add the Ready for Review label so maintainers can finalize the review and merge it. 🎉

We appreciate your contributions and look forward to building an incredible decentralized streaming platform together!