Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (66 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

92 lines (66 loc) · 3.09 KB

Contributing to Augo

First off, thank you for considering contributing to Augo! It's people like you that make the open source community such an amazing place to learn, inspire, and create.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

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. Use a clear and descriptive title.
  • Provide a step-by-step reproduction of the issue.
  • Include environment details (OS, Python version, Flutter version).

Suggesting Enhancements

  • Open a new issue with the tag "enhancement".
  • Describe the feature you'd like to see and why it would be useful.
  • If possible, provide mockups or workflow diagrams.

Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes.
  4. Ensure your code follows the project's style (run make lint and make format for backend).
  5. Submit a pull request with a clear description of the changes.

Development Setup

Backend (Python 3.13 / FastAPI)

  1. Install uv.
  2. Run make setup to install dependencies and initialize the environment.
  3. Use make dev or make start to run the development server.

Frontend (Flutter)

  1. Ensure you have Flutter 3.x installed.
  2. Run make setup-all from the root or navigate to client and run flutter pub get.
  3. Run make client-run or flutter run.

Coding Standards

Backend

  • Use type hints for all function signatures.
  • Follow Google-style docstrings.
  • Use ruff for linting and formatting.
  • All code comments and docstrings must be in English.
    • This ensures international contributors can understand the codebase.
    • Existing Chinese comments are being gradually translated (tracked as tech debt).

Frontend

  • Follow the official Effective Dart guidelines.
  • Use Riverpod for state management.
  • Ensure UI components align with the Forui design system.
  • All code comments must be in English.

Changelog Policy

During the alpha/beta phase, we use a lightweight changelog process:

  • DO NOT update CHANGELOG.md for every commit or PR.
  • Use clear, descriptive commit messages following Conventional Commits.
  • The changelog will be generated from commit history when releasing a new version.

Commit message format:

<type>(<scope>): <description>

Examples:
feat(auth): add rate limiting for login endpoint
fix(budget): correct monthly calculation logic
docs: update self-hosting guide
refactor(agent): simplify middleware chain
test(services): add auth security tests

Commit types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only
  • refactor: Code refactoring
  • test: Adding or updating tests
  • chore: Maintenance tasks

License

By contributing, you agree that your contributions will be licensed under the project's AGPLv3 License.