Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (44 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 2.26 KB

Contributing to LearnLoop 🤝

Thank you for your interest in contributing to LearnLoop! 🎓

We welcome contributions that help improve learning outcomes, accessibility, and AI-powered features. Whether you're fixing bugs, suggesting features, or improving documentation — you're appreciated.

🛠 Contribution Workflow

  1. Fork the repository to your own GitHub account.
  2. Clone your fork to your local machine: 
    git clone https://github.com/your-username/learnloop.git
  3. Create a new branch for your specific changes: 
    git checkout -b feature/your-feature-name 
# Use 'bugfix/' for fixes or 'refactor/' for cleanups
  4. Make your changes (code, documentation, or assets).
  5. Commit with clear messages (see guidelines below).
  6. Push your changes and open a Pull Request (PR) against the main branch of the original augusto-mate/learnloop repository.

📝 Commit Guidelines (Conventional Commits)

We use the Conventional Commits specification to keep our history clean. Every commit message must start with a type:

  • feat: A new feature or capability.
    • Example: feat: add voice input support
  • fix: A bug fix.
  • refactor: Code restructuring without changing external behavior.
  • docs: Documentation changes (like this file or README).
  • style: Changes that do not affect the meaning of the code (whitespace, formatting).

💡 What You Can Work On

We prioritize contributions that align with our mission:

  • UI/UX improvements (mobile-first, accessibility)
  • AI enhancements (feedback, analogies, emotional tone)
  • Localization and offline support
  • Gamification features
  • Documentation and tutorials

✅ Code & Style

  • All code must be clear, readable, and follow existing naming conventions (e.g., camelCase for JavaScript variables).
  • Ensure your code passes all existing tests (if applicable).
  • Formatting: We use standard formatting. Please run a local linter/formatter if possible before submitting (e.g., Prettier, Black).

📬 Questions?

Open an issue first to discuss large features, or reach out via Discussions.

Thanks for helping us build a better learning loop!