forked from flutter/flutter
-
Notifications
You must be signed in to change notification settings - Fork 1
Setting up the Packages development environment
stuartmorgan edited this page May 12, 2021
·
2 revisions
- A working Flutter installation.
- git (used for source version control).
- An ssh client (used to authenticate with GitHub).
- Ensure all the dependencies described in the previous section are installed.
- Fork
https://github.com/flutter/packages
into your own GitHub account. If you already have a fork, and are now installing a development environment on a new machine, make sure you've updated your fork so that you don't use stale configuration options from long ago. - If you haven't configured your machine with an SSH key that's known to github, then follow GitHub's directions to generate an SSH key.
git clone [email protected]:<your_name_here>/packages.git
cd packages
-
git remote add upstream [email protected]:flutter/packages.git
(So that you fetch from the master repository, not your clone, when runninggit fetch
et al.)
There are scripts for many common tasks (testing, formatting, etc.) that will likely be useful in preparing a PR. See the tools README for more details.
The flutter/packages repository uses the published copy of the tools. Set it up by running the following:
pub global activate flutter_plugin_tools
- Home of the Wiki
- Roadmap
- API Reference (stable)
- API Reference (master)
- Glossary
- Contributor Guide
- Chat on Discord
- Code of Conduct
- Issue triage reports
- Our Values
- Tree hygiene
- Issue hygiene and Triage
- Style guide for Flutter repo
- Project teams
- Contributor access
- What should I work on?
- Running and writing tests
- Release process
- Rolling Dart
- Manual Engine Roll with Breaking Commits
- Updating Material Design Fonts & Icons
- Postmortems
- Setting up the Framework development environment
- The Framework architecture
- The flutter tool
- API Docs code block generation
- Running examples
- Using the Dart analyzer
- The flutter run variants
- Test coverage for package:flutter
- Writing a golden-file test for package:flutter
- Setting up the Engine development environment
- Compiling the engine
- Debugging the engine
- Using Sanitizers with the Flutter Engine
- Testing the engine
- The Engine architecture
- Flutter's modes
- Engine disk footprint
- Comparing AOT Snapshot Sizes
- Custom Flutter engine embedders
- Custom Flutter Engine Embedding in AOT Mode
- Flutter engine operation in AOT Mode
- Engine-specific Service Protocol extensions
- Crashes
- Supporting legacy platforms
- Metal on iOS FAQ
- Engine Clang Tidy Linter
- Why we have a separate engine repo
- Reduce Flutter engine size with MLGO
- Setting up the Plugins development environment
- Setting up the Packages development environment
- Plugins and Packages repository structure
- Plugin Tests
- Contributing to Plugins and Packages
- Releasing a Plugin or Package
- Unexpected Plugins and Packages failures