From 265825f1cc52334c33655a29a0a99c3cfa7f4658 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 19 Jan 2026 11:31:52 +0000 Subject: [PATCH] Update documentation: create CONTRIBUTING.md, update README and AGENTS --- AGENTS.md | 8 ++++++++ CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ README.md | 2 +- 3 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/AGENTS.md b/AGENTS.md index 1395ee2..2f3ef80 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1b127ff --- /dev/null +++ b/CONTRIBUTING.md @@ -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). diff --git a/README.md b/README.md index 4d65696..c03a736 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - [Setup & Configuration](./docs/setup.md) - [Development Guide](./docs/development.md) +- [Contribution Guide](./CONTRIBUTING.md) ## Overview @@ -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