From 07931e615e30d2fd08ad1c2e936a7a1abec141eb Mon Sep 17 00:00:00 2001 From: Parker Lougheed Date: Fri, 25 Sep 2026 15:06:47 +0800 Subject: [PATCH] Clean up repository READMEs and Markdown files --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++--- CONTRIBUTING.md | 18 ++++++++++---- README.md | 40 +++++++++++++++++--------------- _archive/README.md | 5 ++-- 4 files changed, 40 insertions(+), 29 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c11828fe..b4301457 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,10 @@ *What changes are you making, and why?* -Keep in mind: **This repository is not maintained.** If you *aren't* the demo owner and/or working on behalf of the demo owner, are you sure they're necessary? These demos are intended to be snapshots in time, and PRs aren't monitored. +Keep in mind: **This repository is not maintained.** If you *aren't* the demo owner and/or working on behalf of the demo owner, are you sure they're necessary? These demos are intended to be snapshots in time, and PRs aren't monitored. -## Pre-launch Checklist +## Pre-launch checklist -- [ ] I signed the [CLA]. +- [ ] I signed the [CLA][]. [CLA]: https://cla.developers.google.com/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efd7a191..9cd7ed92 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,22 @@ -# How to Contribute +# How to contribute -This repo is for code that supports talks, blogs, and experiments. The code is unmaintained and presented "as-is". As such, the repo is not monitored for pull requests and/or issues, and you likely don't want to spend time contributing. +This repo is for code that supports talks, blogs, and experiments. +The code is unmaintained and presented "as-is". +As such, the repo is not monitored for pull requests and/or issues, +and you likely don't want to spend time contributing. -**If you're on the Dash team at Google,** this repo is appropriate for **any** demo, sample, experiment, etc that you don't want to commit to maintaining. This repository is a catch-all for code that just doesn't belong anywhere else. +**If you're on the Dash team at Google,** +this repo is appropriate for **any** demo, sample, experiment, or similar that +you don't want to commit to maintaining. +This repository is a catch-all for code that just doesn't belong anywhere else. For example: - Demos for talks, events, workshops, or tied to a timeline in some way. - Sample apps that are in-progress. - Sample apps that are tied to experimental features. -- Sample apps in which the running demo app is more important that the code itself. +- Sample apps in which the running demo app is + more important than the code itself. - Code that just doesn't belong anywhere else. -- **Any code that shouldn't be advertised as having best practices or being up to date.** +- **Any code that shouldn't be advertised as + having best practices or being up to date.** diff --git a/README.md b/README.md index a1e1406d..4ed40750 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,27 @@ -# Dash Demos +# Flutter and Dart demos -This repo is for code that supports talks, blogs, and experiments. +This repo is for code and projects that support talks, blogs, and experiments. -**NOTE: This code is provided for demonstration purposes only. -The code is unmaintained, and may not work with newer releases. -Demos may get removed when they are no longer in focus.** +> [!NOTE] +> Projects and code in this repository are for **demonstration purposes only**. +> The code is unmaintained, quality and accuracy aren't guaranteed, +> and projects might not work with newer releases of Flutter and Dart. +> +> Demos might be removed at any time without warning, +> such as when they are no longer maintained or in focus. -## CI +## Demo validation -This repository has CI in the case that you want to test your demo code against the three Flutter channels. **CI is not required to merge code,** it's simply here as a convenience. It's run every night at midnight, and when you make a PR. +This repository doesn't have CI set up, +so demos aren't automatically analyzed or tested. +If you want to verify your demo, +validate it locally before opening a PR. +If the demo is still valid or used, +consider occasionally revalidating and updating the demo. -To add your code to CI: -1. For each Flutter channel, you'll find a CI file in the `/tool` dir called `flutter_ci_script_stable`, `flutter_ci_script_beta`, and `flutter_ci_script_master`. Open the file(s) that correspond to the channel you want to test your code against. +## Archived demos -2. Add the directory name of your project to this array: -```bash -declare -ar PROJECT_NAMES=( - # add projects here -) -``` - -## `_archive` - -Projects can be moved here when they're no longer useful. This is purely cosmetic, and really only signals to readers that you no longer care about this code. +Projects that are no longer useful or too out of date +can be moved to the top-level [`_archive/`](_archive) directory. +This distinction from a top-level demo is purely cosmetic, +and really only signals to readers that you no longer care about this code. diff --git a/_archive/README.md b/_archive/README.md index e5bca035..3ff91c59 100644 --- a/_archive/README.md +++ b/_archive/README.md @@ -1,3 +1,4 @@ -# Demos archive +# Flutter and Dart archived demos -This folder houses demos that are no longer being used for talks, are known to not work, or otherwise we believe are no longer relevant. \ No newline at end of file +This directory houses demos that are no longer being used or referenced, +are known to not work, or otherwise we believe are no longer relevant.