Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
147 lines (97 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

147 lines (97 loc) · 2.63 KB

🤝 Contributing Guidelines

Thank you for considering contributing to this project!
We welcome contributions from everyone — whether it's documentation, UI/UX, backend logic, pose estimation improvements, bug fixes, or feature enhancements.

🛠 1. Setting Up the Project Locally

  1. Fork the repository
  2. Clone your fork:
git clone https://github.com/<your-username>/ai-fitness.git
cd ai-fitness
  1. Create a new branch:
git checkout -b feature/<feature-name>

📌 2. How You Can Contribute

You may contribute in several ways, including:

✔ Improving documentation
✔ Enhancing AI pose estimation logic
✔ UI/UX improvements (Web interfaces)
✔ Adding new exercises / features
✔ Bug fixes & patches
✔ Performance or optimization work
✔ Adding automated tests

If unsure, feel free to open an Issue and ask for clarification.

🐛 3. Issue Workflow

Before submitting code, consider opening an Issue for:

  • Bugs
  • Enhancements
  • Feature proposals
  • Questions
  • Clarifications

Link issues in PRs using:

Closes #<issue-number>

🌿 4. Branching Strategy

  • main → stable production-ready code
  • feature/<name> → new features
  • fix/<name> → bug fixes

🧾 5. Commit Message Format

Use descriptive commit messages:

<type>: <short summary>

Where <type> can be:

  • feat → new feature
  • fix → bug fix
  • docs → documentation
  • refactor → code restructuring
  • test → tests added/updated
  • perf → performance improvements

Examples:

docs: improve installation instructions
feat: add squats pose detection module
fix: resolve crash when webcam not found

🔁 6. Pull Request Process

When opening a PR, please ensure:

  • Describe the changes clearly
  • Link relevant Issues
  • Include screenshots for UI updates (if relevant)
  • Ensure local testing passes
  • PR targets the main branch
  • No breaking changes unless discussed

✔ 7. PR Checklist

Before submitting, confirm:

  • Code builds without errors
  • Tested locally
  • Documentation updated (if needed)
  • Issues linked (if applicable)
  • This PR is ready for review

🧩 8. Code Style

Try to maintain consistency in:

  • Naming conventions
  • File organization
  • Function structure

This helps long-term maintainability.

💬 9. Communication

If you need help:

  • Open an Issue
  • Comment on existing Issues
  • Request review on PR

We encourage collaborative discussion.

❤️ 10. Thanks!

Thank you for contributing — we appreciate your time and effort!
Making open-source better is a team effort 🙌