Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (24 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.17 KB

Contributing to LiveLectureAI

First off, thank you for considering contributing to LiveLectureAI! It's people like you that make this tool better for everyone.

How Can I Contribute?

Reporting Bugs

  • Check the Issues tab to see if the bug has already been reported.
  • If not, create a new issue. Please include a clear title, a description of the bug, and steps to reproduce it.

Suggesting Enhancements

  • Open a new issue with the tag enhancement.
  • Describe the feature you'd like to see and why it would be useful.

Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with clear messages.
  4. Push to your fork and submit a Pull Request.

Commit Message Guidelines

We follow a simple commit convention:

  • feat: for new features
  • fix: for bug fixes
  • docs: for documentation changes
  • chore: for maintenance tasks

Style Guide

  • Follow the PEP 8 style guide for Python.
  • For Flutter, follow the official Dart style guide.

Thank you for your contribution!