-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
79 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Flutter Template Changelog | ||
|
|
||
| @formatter:off | ||
| * All notable changes to this project will be documented in this file. | ||
| * The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
| * This template is based on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). | ||
|
|
||
| ### Guiding Principles | ||
|
|
||
| - Changelogs are for humans, not machines. | ||
| - There should be an entry for every single version. | ||
| - The same types of changes should be grouped. | ||
| - Versions and sections should be linkable. | ||
| - The latest version comes first. | ||
| - The release date of each version is displayed. | ||
| - Mention whether you follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ### Types of changes | ||
|
|
||
| - `Added` for new features. | ||
| - `Changed` for changes in existing functionality. | ||
| - `Deprecated` for soon-to-be removed features. | ||
| - `Removed` for now removed features. | ||
| - `Fixed` for any bug fixes. | ||
| - `Security` in case of vulnerabilities. | ||
| - `Performance` for improvements in performance. | ||
| - `Style` for changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | ||
| - `Docs` for documentation only changes | ||
| - `Build` for changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | ||
|
|
||
| ### [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) | ||
|
|
||
| A specification for adding human and machine readable meaning to commit messages. | ||
|
|
||
| - `feat` a new feature | ||
| - `fix` a bug fix | ||
| - `docs` documentation only changes | ||
| - `style` changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | ||
| - `refactor` a code change that neither fixes a bug nor adds a feature | ||
| - `perf` a code change that improves performance | ||
| - `test` adding missing tests or correcting existing tests | ||
| - `build` changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | ||
| - `chore` other changes | ||
| - **BREAKING CHANGE**: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. | ||
|
|
||
| --- | ||
|
|
||
| ### Well-known flutter-analyzer issues | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ### Appendix Issues | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| @formatter:off | ||
|
|
||
| # Releases | ||
|
|
||
| ## [Unreleased]() | ||
| ### Added | ||
| - None | ||
|
|
||
| ### Changed | ||
| - None | ||
|
|
||
| ### Fixed | ||
| - None | ||
|
|
||
| ### Removed | ||
| - None | ||
|
|
||
| ### BREAKING CHANGES | ||
| - None | ||
|
|
||
|
|
||
| --- |