Visitar URL original
[pigeon] Added a contributor's guide. by gaaclarke · Pull Request #324 · flutter/packages · GitHub
Skip to content
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
feedback 1
  • Loading branch information
gaaclarke committed Apr 7, 2021
commit 2caa6903d4c183a0a8d0fac0e61b549f3597fe97
7 changes: 2 additions & 5 deletions packages/pigeon/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Pigeon Contributor's Guide

**author:** gaaclarke\
**updated:** 4/6/21

## Description

Pigeon is a code generation tool that adds type safety to Flutter’s Platform
Expand All @@ -11,7 +8,7 @@ people who would like to contribute to the project.

## State Diagram

Pigeon generates a temporary file in it's LaunchIsolate, then launches another
Pigeon generates a temporary file in its LaunchIsolate, then launches another

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might have to define these words for contributors.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I defined LaunchIsolate and PigeonIsolate.

isolate that uses dart:mirrors to parse the generated file, creating an AST,
then running code generators with that AST.

Expand Down Expand Up @@ -65,7 +62,7 @@ Pigeon has 3 types of tests, you'll find them all in [run_tests.sh](./run_tests.
code, then execute the generated code. It can be thought of as unit-tests run
against the generated code. Examples: [platform_tests](./platform_tests)

## Eminent Plans
## Imminent Plans

* Migrate to Dart Analyzer for AST generation ([issue

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a high maintenance text. Maybe just link to your Pigeon next steps doc or to a GitHub project under the flutter/flutter or flutter/packages?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it isn't ideal but this is where I have people's attention that want to contribute and I think the 2 points are important (see my response to Stuart above). Hopefully 1 year from now the need for this section would be eliminated since we won't have any big changes coming and the testing will be even more mature.

78818](https://github.com/flutter/flutter/issues/78818)) - We might have
Expand Down