Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

78 lines (50 loc) · 1.69 KB

Contributing to Spark-IQ

Thanks for your interest in contributing to Spark-IQ! 🎉 We welcome all contributions, whether it's a bug report, feature suggestion, code improvement, or documentation update.

📌 How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of this repo, then clone your fork:

git clone https://github.com/YOUR_USERNAME/Spark-IQ.git
cd Spark-IQ

2. Create a New Branch

Use a clear name that describes your change:

git checkout -b feature/your-feature-name

3. Make Changes

Please ensure your code is:

  • Clean and well-commented
  • Following existing style and conventions
  • Passing all linter or build checks

4. Commit Your Changes

Use meaningful commit messages:

git add .
git commit -m "Add: new feature explanation"

5. Push and Submit a Pull Request (PR)

git push origin feature/your-feature-name

Then go to the original Spark-IQ repo and open a Pull Request.

✅ Contribution Guidelines

  • Write clear, descriptive titles for issues and PRs.
  • For large changes, open an issue first to discuss it.
  • Be respectful in code reviews and discussions.
  • Avoid breaking existing functionality.
  • Ensure your PR only includes relevant changes.

🛠️ Reporting Bugs

If you find a bug:

  1. Check if it's already reported.

  2. If not, open an issue.

  3. Include:

    • What happened
    • What you expected
    • Steps to reproduce (screenshots or code snippets help)

🙌 Thank You!

Your contributions make this project better for everyone. We appreciate your support and look forward to collaborating with you!