Skip to content

Update documentation for proto-flutter-plugin #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
google-labs-jules wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update documentation for proto-flutter-plugin #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,19 @@ This file contains instructions and context for AI agents (and humans) working o
## Project Structure

- `src/`: Source code for the Rust plugin.
- `docs/`: Additional documentation.
- `build-wasm.sh`: Script to build the WASM plugin.
- `Cargo.toml`: Rust project configuration.
- `.moon/`: moon repository configuration directory.
- `moon.yml`: Project-level moon task definitions.
- `.prototools`: Proto tool versions configuration.
- `CONTRIBUTING.md`: Contribution guidelines.

## Documentation

Agents should refer to the `docs/` directory for detailed information:
- `docs/setup.md`: Configuration and installation.
- `docs/development.md`: Building, testing, and release process.

## Build Requirements

Expand Down
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to the Flutter proto plugin

Thank you for your interest in contributing! We welcome bug reports, feature requests, and pull requests.

## Getting Started

To get started with development, please read our [Development Guide](./docs/development.md). It covers:

- Prerequisites (Rust, WASM targets, etc.)
- Building the plugin
- Running tests
- Release process

## Reporting Bugs

If you find a bug, please open an issue on GitHub. Include:

- Steps to reproduce
- Expected behavior
- Actual behavior
- Your environment (OS, proto version, etc.)

## Submitting Pull Requests

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Make your changes.
4. Run tests and linting (`moon run :check`).
5. Submit a pull request.

## Code Style

- We use `cargo fmt` for formatting.
- We use `cargo clippy` for linting.
- Please ensure your code passes all checks before submitting.

## License

By contributing, you agree that your contributions will be licensed under the project's [LICENSE](./LICENSE).
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

- [Setup & Configuration](./docs/setup.md)
- [Development Guide](./docs/development.md)
- [Contribution Guide](./CONTRIBUTING.md)

## Overview

Expand All @@ -25,7 +26,6 @@ This plugin allows you to manage Flutter SDK versions using `proto`.

- **Channel Switching**: The plugin does not support the native `flutter channel` command. Use `proto` to install different channel versions (e.g., `proto install flutter beta`).
- **Self-Upgrades**: `flutter upgrade` and `flutter downgrade` are not supported. Version control is fully managed by `proto`.
- **Platform Support**: While it aims to support major platforms, there are known issues with archive formats on Windows in the current implementation (forces `.tar.xz`).

## Quick Start

Expand Down