Commit Graph

85 Commits

Author SHA1 Message Date
Anis Alibegić
e2ada1c939
Fixed typos (#159331)
Here's another one of my PRs where I hunt for typos across `flutter`
repo.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] All existing and new tests are passing.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#overview
[Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene
[test-exempt]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes
[Discord]: https://github.com/flutter/flutter/wiki/Chat
2024-12-05 16:54:09 +00:00
Gray Mackall
f2446f2dfb
Add docs for setting up Android Studio to auto format Kotlin code (#159209)
Docs to make Android Studio auto format kotlin code in a way compatible
with the format check that we make in CI.

Open to suggestions as to a better place to put them, but there wasn't
an existing doc that seemed like an obvious fit to me.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

---------

Co-authored-by: Gray Mackall <mackall@google.com>
Co-authored-by: Reid Baker <hamilton.reid.baker@gmail.com>
2024-11-20 20:58:39 +00:00
HongeSun
15a03a4ada
Fix git command in Quality-Assurance.md (#155146)
Correct the Quality-Assurance contributing doc's wrong git command.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] All existing and new tests are passing.
2024-11-20 06:32:04 +00:00
Kate Lovett
26d5ec3edd
Prettier merge_queue.md (#158969)
Spruced up a bit, added mention of edge case for older PRs.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

---------

Co-authored-by: David Iglesias <ditman@gmail.com>
2024-11-18 19:32:23 +00:00
Yegor
bb5287ad6d
[flutter triage] Update list of frequent web contributors (#159008)
Update list of frequent web contributors
2024-11-15 23:30:59 +00:00
Yegor
917b48d942
Style change in Flutter-Web-Triage.md (#159006)
Mostly just testing the MQ functionality
2024-11-15 22:13:31 +00:00
Kate Lovett
34b5c274bb
Create merge_queue.md (#158959)
Adds information on the merge queue, to be used for announcement. Will update to final doc after the merge project is complete.
2024-11-14 23:50:05 +00:00
stuartmorgan
8f62a9904d
Update triage flow chart for SVG packages (#158670)
Adds special handling of the newly-imported `flutter_svg` and
`vector_graphics` family of packages in the triage flow chart, as they
should be directed to the engine team.
2024-11-14 05:39:39 -05:00
Nate Wilson
e77093bba4
"Fix failing checks" wiki page for new contributors (#154629)
Resolves https://github.com/flutter/flutter/issues/154628

<br>

As a contributor, I would expect resources related to testing to be located in the [/docs/contributing/testing](https://github.com/flutter/flutter/tree/master/docs/contributing/testing) directory. This PR adds a page to that directory geared toward helping new contributors.

<br>

I've noticed that in `team-framework` triage meetings, comments along the lines of "could you take a look at the failing checks?" are a regular occurrence.

I believe we could save quite a bit of effort by changing this:

> [**Understanding a LUCI build failure**](a5ca16ea94/docs/infra/Understanding-a-LUCI-build-failure.md)

to this:

> [**Flutter wiki – How to fix failing checks**](https://github.com/nate-thegrate/flutter/blob/fix-checks-wiki-page/docs/contributing/testing/Fix-failing-checks.md)
2024-11-13 18:52:27 +00:00
stuartmorgan
2afadc2cdf
Add flutter/package code generation instructions (#158326)
Adds general instructions for updating generated code in
flutter/packages, covering the common cases of Pigeon and Mockito
generation.

Fixes https://github.com/flutter/flutter/issues/158321
2024-11-08 08:17:07 -05:00
Polina Cherkasova
1f1eec06f1
Make leak tracking bots blocking. (#157866)
See http://flutter.dev/go/leak-tracker-make-bots-blocking
2024-11-07 00:23:04 +00:00
chunhtai
cfa3b08578
excluding website-cms from critical pr triage (#158220)
Since we skipped all website cms pr during critical triage anyway
2024-11-06 17:11:14 +00:00
Matan Lurey
abcdcee57a
Remove references to the HTML renderer in public docs. (#158035)
Closes https://github.com/flutter/flutter/issues/157547.
2024-11-04 23:28:38 +00:00
Polina Cherkasova
9cf98f7273
Create flutter specific leak troubleshooting guidance. (#157396) 2024-10-25 13:25:34 -07:00
Andrew Kolos
dad3fea650
docs: Rework "Making changes to the flutter tool" to include flutter-dev (#157480)
Follow-up to https://github.com/flutter/flutter/pull/153599. This updates the tool readme, suggesting `bin/flutter-dev` as the primary way to run the flutter tool locally from source.

<details>

<summary> Pre-launch checklist </summary> 

</details>
2024-10-23 23:28:57 +00:00
stuartmorgan
e0d6271911
Update ecosystem contribution docs (#157288)
Document the requirements for adding a new external, client-facing dependency in flutter/packages
2024-10-21 19:06:04 +00:00
Kate Lovett
19488bd6bd
Update triage doc (#155716) 2024-10-15 15:34:10 -05:00
stuartmorgan
14272d54dc
Update iOS/macOS plugin test information (#156716)
Updates the paths for test files to reflect the `darwin/` structure, and updates the instructions for enabling tests to use the SPM version of OCMock if necessary (as well as flagging that new use of OCMock is discouraged).
2024-10-14 17:31:18 +00:00
Loïc Sharma
ecf3d6c39a
Clarify when override: no versioning needed label should be applied (#156342)
Follow-up to https://github.com/flutter/packages/pull/7796

Part of https://github.com/flutter/flutter/issues/156259
2024-10-07 21:09:19 +00:00
Reid Baker
885338e762
Update Upgrading-Engine's-Android-API-version.md to reflect code move (#156108)
these files moved during https://github.com/flutter/engine/pull/55186/files
2024-10-02 19:45:09 +00:00
Chris Bracken
f7bcb28584
docs: Update gardener doc with tree-gardener channel (#155972)
In order to have a dedicate chat room for tree issues with a high signal to noise ratio, we've separated out a new `tree-gardener` channel from the `tree-status` channel on Discord. This updates the gardener docs to reference the new human-centric tree-gardener chat.

I've removed the line suggesting that people avoid spamming the room with requests for "when will this be resolved?" and "can I get an update?" since the doc is aimed mostly at the gardener themself and and not likely being read by those on chat asking "when will the tree be fixed?" Recently this hasn't been a source of noise.
2024-10-01 16:51:49 +00:00
Parker Lougheed
22570daa18
Misc docs cleanup and fixes (#155501) 2024-09-24 20:03:08 +00:00
Michael Goderbauer
c6b0876a2f
Quick access to style guide (#154689) 2024-09-06 15:45:04 +00:00
Matan Lurey
a782869b34
Add documentation about updating .ci.yaml and flutter-gold. (#154184)
Closes https://github.com/flutter/flutter/issues/143863.

/cc @christopherfujino
2024-08-28 17:25:44 +00:00
Lxxyx
602f9affa6
doc: fix typo in testing doc (#154105)
*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*

*List which issues are fixed by this PR. You must list at least one issue. An issue is not required if the PR fixes something trivial like a typo.*

*If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].*

- [] I listed at least one issue that this PR fixes in the description above.
- [] I added new tests to check the change I am making, or this PR is [test-exempt].
- [] I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
- [] All existing and new tests are passing.

## Detail
The correct parameter is --web-port, not --webport
2024-08-26 18:15:05 +00:00
Jenn Magder
acaccda08d
Update iOS/macOS triage doc links (#153963)
Combine iOS and macOS triage links since it's completed in the same meeting. 
1. Remove `no:assignee` from both incoming issue links, as these should still be triaged.
2. Combine P0 issue and packages PR links. Other links are harder to combine. For example, macOS PRs looks for `"affects: desktop"` but iOS PRs do not.
2024-08-22 22:31:59 +00:00
Reid Baker
72d1d15b4f
Create Postmortem-Platform-View-android-14-regression (#149201)
Title and initial timeline addition for flutter android 14 platform view
issues.
Internal to google version of this doc.
[go/flutter-android-14-postmortem](http://goto.google.com/flutter-android-14-postmortem)


- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
2024-08-21 10:21:57 -04:00
chunhtai
9e91307947
Update README.md (#153470)
*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*

*List which issues are fixed by this PR. You must list at least one issue. An issue is not required if the PR fixes something trivial like a typo.*

*If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].*
2024-08-16 17:57:26 +00:00
chunhtai
5fdc911135
adds team-accessibility to triage workflow (#153575)
add team-accessibility to triage workflow
2024-08-16 17:19:06 +00:00
Nate Wilson
a0c04534f5
Style Guide updates (#152525)
This pull request updates the style guide for improved internal consistency and to match current linter rules.

I'll make comments for each change here!
2024-08-16 16:19:06 +00:00
Justin McCandless
73c9e4e578
Design-Documents.md incorrect link (#153509)
Fixed an incorrect link. I think it was accidentally pasted twice.
2024-08-15 22:02:00 +00:00
Camille Simon
f697d61025
Update docs to use new Android version in the engine (#151601)
Updates the steps based on what I found by working on https://github.com/flutter/engine/pull/54186 and https://github.com/flutter/engine/pull/53574 + general cleanup.
2024-08-14 19:57:07 +00:00
gaaclarke
fa1216761d
Added FlutterEngineGroups to engine architecture doc (#153100)
I also formatted the markdown as per our guidelines.  I kept the commits for formatting separate if you want to ignore those.
2024-08-12 22:00:33 +00:00
Parker Lougheed
b6cd31e6b5
Add a contribution doc on using reliable links in tooling (#150962)
The final piece of https://github.com/flutter/website/issues/10363 now that most existing relevant links have been updated to use the new redirects.
2024-08-08 13:32:04 +00:00
Kate Lovett
2ff7fe92c1
Update design languages triage link to exclude drafts (#153027)
Noticed the framework triage was doing this, adopting it for design languages as well!

Critical triage follows up on these draft PRs if they sit for long without an update. Having draft PRs allows folks to discuss changes without getting nudged constantly to make progress on it. This feels like a really positive change.
2024-08-07 16:45:51 +00:00
Rexios
79d5ecc902
[wiki] Remove outdated warning about stale coverage data (#152560)
Remade https://github.com/flutter/flutter/pull/152529 because the GitHub editor was being dumb and adding trailing newlines without asking
2024-08-02 18:21:58 +00:00
Camille Simon
0b41781c78
Update docs to support new Android version (#152503)
Includes the following updates:

- Spacing and capitalization fixes for readability
- Corrects instructions on updating AVD dependencies
- Links to engine docs to reduce redundancy
2024-07-31 20:47:04 +00:00
Matan Lurey
888149f9f5
Clarify and cleanup the test-exemption wording in tree-hygiene. (#152402)
Based off a [discussion on
Discord](https://discord.com/channels/608014603317936148/608018585025118217/1266501306852446421),
but I've also anecdotally had a few people ask this before.

Other than a bit of reformatting, I wanted to clarify that the PR
reviewer should still _agree_ an exemption is needed (i.e. not defer
this responsibility entirely to our small volunteer staff of reviewers),
and that _all_ reviewers should feel empowered to push back, and not
wait for a test exemption reviewer to do it. This [matches the guidance
in the
bot](f1b20b6e4c/app_dart/lib/src/service/config.dart (L253-L255)).

If this change LGTY I can make a [minor change to the Github
bot](f1b20b6e4c/app_dart/lib/src/service/config.dart (L239-L255))
as well.
2024-07-30 16:53:54 -07:00
Rexios
dfedcfe702
[wiki] Remove text saying wiki edits do not get code reviewed (#152530)
Sequel to https://github.com/flutter/flutter/pull/152529
2024-07-30 03:23:37 +00:00
Reid Baker
771650ca16
Update New-Android-version.md (#152395)
Related to https://github.com/flutter/flutter/issues/152374
2024-07-29 15:18:56 +00:00
Yegor
b4d7721af0
Update Flutter-Web-Triage.md (#152191)
Separate P0 triage from P1 triage.
2024-07-23 13:37:59 -07:00
Kevin Chisholm
28033eabc2
[Release] Update release note location (#151931)
**TLDR:** Move the changelog, currently called ["hotfixes to the stable
channel"](https://github.com/flutter/flutter/blob/master/docs/releases/Hotfixes-to-the-Stable-Channel.md),
to the root directory of Flutter/Flutter and rename it to CHANGELOG.md
before the Q3 release cutoff.

This PR accomplishes the following:
1. Renames 'Hotfixes-to-the-stable-channel' to CHANGELOG.md
2. Moves CHANGELOG.md to Flutter/Flutter root.
3. Update references to 'Hotfixes-to-the-stable-channel' to
CHANGELOG.md.

---

#### Background
Flutter has historically kept documentation on wiki pages in the Flutter
repository. Recently, we executed a large-scale migration of our wiki
into a `docs` folder within flutter/flutter.

#### Proposal
I propose relocating the current changelog, which is called ["hotfixes
to the stable
channel"](https://github.com/flutter/flutter/blob/master/docs/releases/Hotfixes-to-the-Stable-Channel.md),
to the root directory of the Flutter/Flutter repository and renaming it
to CHANGELOG.md. This change aims to improve the visibility,
accessibility, and consistency of our documentation processes.

#### Benefits
1. **Unify Dart and Flutter Processes:** This move aligns Flutter’s
changelog management with Dart's practices. As the release manager for
both Dart and Flutter, this unification will streamline the processes
and ensure consistency across projects.

#### Timeline
I would like this proposal **approved or denied before the Q3 release
cutoff** so it may be available within the stable branch.

---

> [!NOTE] 
> This proposal aims to improve our workflow and documentation
standards. I am open to feedback and further discussion on how we can
best implement this change.
2024-07-23 11:53:20 +07:00
Kevin Chisholm
5040232763
Adds 3.22.3 changelog (#151974) 2024-07-19 01:00:00 +07:00
Yegor
8e6643c597
[web] use the new backlog Github project in triage links (#151920)
https://github.com/orgs/flutter/projects/132 is going away.

https://github.com/orgs/flutter/projects/41 is the new project we use
for backlog tracking.
2024-07-17 15:28:13 -07:00
Yegor
fb9cadb0f5
Update Flutter-Web-Triage.md (#151607)
Update regular contributor list on the Flutter Web Triage wiki page.
2024-07-17 15:23:14 -07:00
Kishan Rathore
355fe44f19
docs: Fix typo in data driven fixes test folder section (#151836)
Previously we were having `corresponding` written as `curresponding`.
2024-07-17 18:10:17 +00:00
Matan Lurey
8a0b34c9b9
Delete docs/engine directory (#151616)
Closes https://github.com/flutter/flutter/issues/150869.

Pending the following:
- https://github.com/flutter/.github/pull/47
- https://github.com/flutter/flutter/pull/151614
- https://github.com/flutter/engine/pull/53828
- https://github.com/flutter/engine/pull/53829

The wiki backlinks and website have all been updated to <https://github.com/flutter/engine/tree/main/docs>.
2024-07-17 17:58:48 +00:00
Seth Ladd
ba57fa3821
Update Design-Documents.md (#151472)
Make it more clear that every design doc has a corresponding github tracking issue with appropriate label.

*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*

*List which issues are fixed by this PR. You must list at least one issue. An issue is not required if the PR fixes something trivial like a typo.*

*If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].*
2024-07-16 16:01:10 +00:00
Loïc Sharma
ada8def2c9
Add link to design document archive (#151489) 2024-07-11 22:58:04 +00:00
Ian Hickson
32c0c39ea5
Mention not @-mentioning people in commit messages in tree hygiene (#151487)
Update style guide to include anti pattern of mentioning someone in a comment and the flurry of notifications that result. 

Came up in a google contributor roundtable discussion.
2024-07-10 15:06:01 +00:00