Skip to content

Document why files are in the template #9884

@Hixie

Description

@Hixie

Before we add more files to the template, I think we should make sure the template contains a README that documents, for each file in the template:

  • What the file is for
  • Why you would edit that file
  • How to verify that the edits are valid
  • How to test the file

The template is growing really big and it's not at all clear why some of these files are part of the user code and not just part of the framework.

We should also have a test that verifies that all files created by "flutter create" have an entry in this README file.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Important issues not at the top of the work listc: contributor-productivityTeam-specific productivity, code health, technical debt.d: examplesSample code and demosd: wikiFlutter or engine wikisteam-toolOwned by Flutter Tool teamtoolAffects the "flutter" command-line tool. See also t: labels.triaged-toolTriaged by Flutter Tool team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions