Commit Graph

66 Commits

Author SHA1 Message Date
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
Gray Mackall
72d75959a0
Link engine docs on AS setup in flutter/flutter docs on engine contributor setup (#151481)
Links to the docs on Android Studio setup.
2024-07-09 20:35:42 +00:00
Nate Wilson
aad381638d
Add a message about spam/brigading (#150583)
~~I decided to add this message to CODE_OF_CONDUCT.md~~ never mind 🙂 

Let me know if anything should be changed.
2024-07-03 20:18:04 +00:00
Kate Lovett
143847626d
Update deprecation policy (#151257)
We are pausing our cadence of removing deprecated API from the framework until we can create a new policy.
The last couple of cycles we noticed customers having more difficult migrations, and it being harder to remove the APIs in the scheduled time period. So we need to reevaluate the policy and update it.

This is the policy working as intended. Signals like flutter/tests provide feedback on how we are affecting users - so that for folks that contributed!

Related to https://github.com/flutter/website/pull/10839
2024-07-03 20:01:07 +00:00
derdilla
91b928d52f
Fix link in tree hygene doc (#151235)
Link in how section of tree hygiene doc pointed to the wrong url for the style-guide doc introduced in [#148790](65abc95542).
2024-07-03 17:56:46 +00:00
Snoppy
65cd7cf7b2
chore: fix typos and link broken (#150402)
**fix some typos and link broken**
2024-07-03 17:10:19 +00:00
Samuel Wrenn
05f294c711
Fixes for Style Guide for Flutter Repo (#150167)
Fix broken links, typos, and inconsistent formatting in the Style Guide for Flutter Repo.

Fixes [150164](https://github.com/flutter/flutter/issues/150164).
2024-06-26 18:28:03 +00:00
Loïc Sharma
8334a3172c
Add more warm up frame docs (#150464)
Updated the wiki to call out the warm up frame. This contains details from the following pages:

1. b98d48549c/packages/flutter/lib/src/scheduler/binding.dart (L994-L1016)
2. https://api.flutter.dev/flutter/dart-ui/PlatformDispatcher/scheduleWarmUpFrame.html
3. https://api.flutter.dev/flutter/dart-ui/FlutterView/physicalSize.html

Part of https://github.com/flutter/flutter/issues/149974
2024-06-25 20:36:05 +00:00
Parker Lougheed
7404f1be16
Rename doc file to use standard hyphens (#150314)
Fixes https://github.com/flutter/flutter/issues/150313
2024-06-18 00:47:26 +00:00
Kate Lovett
62586dc09d
Update old wiki links (#149544)
Part of https://github.com/flutter/flutter/issues/145009

Finishes updating links in the repo that pointed to the old wiki
2024-06-17 17:26:08 +00:00
yaakovschectman
3bdc451802
Document CIPD role & login for upgrading Android engine (#149433)
Uploading CIPD packages requires the `flutter-cipd-writers` role. This
simply adds this detail to the instructions for updating the Android
Engine's SDK.

This is a documentation-only change.

## Pre-launch Checklist

- [ ] 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].
- [ ] I signed the [CLA].
- [x] 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/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
[Data Driven Fixes]:
https://github.com/flutter/flutter/wiki/Data-driven-Fixes

---------

Co-authored-by: Reid Baker <hamilton.reid.baker@gmail.com>
2024-06-13 18:06:17 -04:00
Nate Wilson
a8f903223b
Fix markdown hyperlinks in the style guide (#150071)
Some of the syntax in the migrated [style guide](14df7be3f9/docs/contributing/Style-guide-for-Flutter-repo.md (lazy-programming)) (and "workarounds for common issues") doesn't show up super well as a `.md` file on GitHub. (related: #145009)

<br>

#### Current

> You may hear team members say "embrace the http://www.catb.org/jargon/html/Y/yak-shaving.html[yak
shave]!". This is an encouragement to https://www.youtube.com/watch?v=AbSehcT19u0[take on the larger effort necessary] to perform a proper fix for a problem rather than just applying a band-aid.

#### This PR

> You may hear team members say "embrace the [yak shave](http://www.catb.org/jargon/html/Y/yak-shaving.html)!". This is an encouragement to [take on the larger effort necessary](https://www.youtube.com/watch?v=AbSehcT19u0) to perform a proper fix for a problem rather than just applying a band-aid.

<br>

Workarounds-for-common-issues.md: [**before**](14df7be3f9/docs/wiki_archive/Workarounds-for-common-issues.md) / [**after**](c8d84a71b7/docs/wiki_archive/Workarounds-for-common-issues.md)
2024-06-12 18:41:10 +00:00
Jenn Magder
0d5bf0f548
Update packages desktop PR triage link lables (#150124)
Change links to desktop package PRs to ones with labels specific to the platform.
2024-06-12 18:04:21 +00:00
stuartmorgan
4afadeae3e
Add a doc for the flutter/packages gardener (#149682)
This is intended to replace the currently internal-only document for flutter/packages gardeners. It is a hybrid of the existing document and the Flutter-Framework-Gardener-Rotation.md document (in order to try to improve consistency relative to just moving the existing doc as-is).
2024-06-12 14:57:00 +00:00
Chris Bracken
95ba272c9c
[docs] Per-platform desktop triage instructions (#150019)
`team-desktop` has been split into `team-linux`, `team-macos`, and `team-windows`. This updates the triage instructions to cover those platforms.
2024-06-10 23:28:17 +00:00
Kate Lovett
01d1e74af5
Remove abi key permanently from golden file testing (#149858)
We have fiddled with this a bunch, and there is definitively no way to reliably include this, so I am removing it.

Since CI does not cover all possible values, we can't consistently look up images for local testing. We thought removing it from the look up would work fine, and it did for most tests, but there were still some that could not find an image without it.

A brief history on the abi key
- added in https://github.com/flutter/flutter/pull/143621
- disabled in https://github.com/flutter/flutter/pull/148023
- added back in https://github.com/flutter/flutter/pull/148072
  - we thought there was only an issue with alphabetizing keys
- removed from local image look up in https://github.com/flutter/flutter/pull/149696

I updated the docs page to also discuss what makes a good key and what does not based on what we learned here.
2024-06-06 23:05:52 +00:00
Kevin Chisholm
32da263b1d
3.22.2 release notes (#149818)
Update "Hotfixes to the stable channel" in preparation for the next hotfix release.
2024-06-06 20:02:57 +00:00
Mouad Debbar
7e414e88e0
Fix some links in the "Handling breaking change" section (#149821)
_Title says it all_
2024-06-06 17:00:51 +00:00
stuartmorgan
8c4295b116
Switch to triage-* labels for platform package triage (#149614)
Currently the ecosystem team triages all PRs in the packages repository, but the platform teams also triage all PRs with their platform label. Due to the way PRs in packages work, however, it's relatively common for a PR to not be relevant to all the teams' triages at all times. Common examples:
- One platform team may LGTM a multi-platform PR for their platform's portion, while another platform goes through review for several more weeks.
- A cross-platform PR may not have high-level design approval from the ecosystem owner, at which point platform implementation review is premature.

To avoid PRs showing up repeatedly in a platform team's triage when it's not relevant, this adjusts the triage structure:
- Queries for PRs in platform teams query `triage-<platform name>` rather than `platform-<platform name>`
- Ecosystem triage will add the `triage-<platform name>` label during triage when a PR is ready for that platform team's consideration.
- Platform teams can remove the label when it's not relevant to them (e..g, after it's been LGTM'd for that platform).

This also adds a desktop PR query, since there wasn't one, covering the separate platforms. They are separated to allow for more triage flexibility in the future.
2024-06-03 22:36:09 +00:00
Kate Lovett
a6ff7123e5
Cleanup triage reports from docs/ (#149545)
Part of https://github.com/flutter/flutter/issues/145009

Meeting notes are some thing that will continue in the wiki, so they do not need to be checked in here.
2024-06-03 15:16:20 +00:00