contributing - Learnathon-By-Geeky-Solutions/binary-brains GitHub Wiki

🤝 Contributing to AmarTech

Thank you for your interest in contributing! We welcome community involvement to help improve AmarTech. Please follow the guidelines below to contribute effectively.

🛠️ Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository: 
    git clone https://github.com/YOUR_USERNAME/binary-brains.git
cd binary-brains
  3. Create a new branch for your feature or fix: 
    git checkout -b your-feature-name
  4. Make your changes.
  5. Run and test the project locally to ensure everything works.
  6. Commit your changes and push to your fork: 
    git add .
git commit -m "Add your message here"
git push origin your-feature-name
  7. Submit a Pull Request with a clear description of your changes.

🔍 Code Style & Practices

  • Follow the existing project structure and naming conventions.
  • Keep controllers clean — move logic into services.
  • Maintain separation of concerns (use services and repositories properly).
  • Write or update unit tests if your code affects logic.
  • Follow clean architecture principles.

📋 Requirements for Contributions

  • .NET Core 8
  • Visual Studio 2022 or Visual Studio Code
  • SQL Server for local development
  • Internet connection for testing Stripe and Facebook Authentication (if needed)

✅ Contribution Checklist

  • Code is well-structured and commented.
  • Existing functionality is not broken.
  • New features are covered with unit tests if applicable.
  • SonarCloud shows no major code smells or coverage drops.
  • Your branch is up-to-date with main.

📢 Need Help?

If you have questions, feel free to open an issue or reach out to the maintainers.