Skip to content

Merge in plugin README and CONTRIBUTING #3252

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

Merged
merged 3 commits into from
Feb 22, 2023
Merged

Merge in plugin README and CONTRIBUTING #3252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b4bd79
Merge in plugin contribution docs
stuartmorgan-g Feb 22, 2023
3f425c8
Minor changes
stuartmorgan-g Feb 22, 2023
ea945d7
Update README as well
stuartmorgan-g Feb 22, 2023
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
31 changes: 21 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
# Contributing to Flutter Packages

[![Build Status](https://api.cirrus-ci.com/github/flutter/packages.svg)](https://cirrus-ci.com/github/flutter/packages/main)

_See also: [Flutter's code of conduct](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md)_

## Welcome

For an introduction to contributing to Flutter, see [our contributor
Expand All @@ -16,15 +10,32 @@ Additional resources specific to the packages repository:
- [Packages repository structure](https://github.com/flutter/flutter/wiki/Plugins-and-Packages-repository-structure),
to get an overview of how this repository is laid out.
- [Contributing to Plugins and Packages](https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages),
for more information about how to make PRs for this repository.
for more information about how to make PRs for this repository, especially when
changing federated plugins.
- [Plugin tests](https://github.com/flutter/flutter/wiki/Plugin-Tests), which explains
the different kinds of tests used for plugins, where to find them, and how to run them.
As explained in the Flutter guide,
[**PRs need tests**](https://github.com/flutter/flutter/wiki/Tree-hygiene#tests), so
this is critical to read before submitting a plugin PR.

## Notes

### Style

Flutter packages follow [Flutter's style
guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo), with the
exception that code is formatted with `dart format`.
Flutter packages and plugins follow Google style—or Flutter style for Dart—for the languages they
use, and use auto-formatters:
- [Dart](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo) formatted
with `dart format`
- [C++](https://google.github.io/styleguide/cppguide.html) formatted with `clang-format`
- **Note**: The Linux plugins generally follow idiomatic GObject-based C
style. See [the engine style
notes](https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style)
for more details, and exceptions.
- [Java](https://google.github.io/styleguide/javaguide.html) formatted with
`google-java-format`
- [Objective-C](https://google.github.io/styleguide/objcguide.html) formatted with
`clang-format`
- [Swift](https://google.github.io/swift/) formatted with `swift-format`

### Releasing

Expand Down
Loading