Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Christopher Fujino <[email protected]>
  • Loading branch information
jonasfj and christopherfujino authored Jul 31, 2023
1 parent 8bfd6e4 commit ed9278c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions pkgs/extension_discovery/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Package Extension Discovery

A convention to allow other packages to provide extension for your package
(or tool). Including logic for finding extensions that honors this convention.
A convention to allow other packages to provide extensions for your package
(or tool). Including logic for finding extensions that honor this convention.

The convention implemented in this package is that if `foo` provides an
extension for `<targetPackage>`.
Then `foo` must contain a config file `extension/<targetPackage>/config.json`.
This file indicates that `foo` provides and extension for `<targetPackage>`.
This file indicates that `foo` provides an extension for `<targetPackage>`.

If `<targetPackage>` accepts extensions from other packages it must:
* Find extensions using `findExtensions('<targetPackage>')` from this package.
* Document how extensions are implemented:
* What should the contents of the `extension/<targetPackage>/config.json` file be?
* Should packages providing extension have a dependency constraint on `<targetPackage>`?
* What libraries/assets should packages that provide extension include?
* Should packages providing extensions have a dependency constraint on `<targetPackage>`?
* What libraries/assets should packages that provide extensions include?
* Should packages providing extensions specify a [topic in `pubspec.yaml`][1]
for easy discovery on pub.dev.

Expand Down

0 comments on commit ed9278c

Please sign in to comment.