xref: /aosp_15_r20/external/skia/relnotes/README.md (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1*c8dee2aaSAndroid Build Coastguard Worker# Skia Release Notes
2*c8dee2aaSAndroid Build Coastguard Worker
3*c8dee2aaSAndroid Build Coastguard WorkerThis directory contains release notes for the upcoming milestone.
4*c8dee2aaSAndroid Build Coastguard Worker
5*c8dee2aaSAndroid Build Coastguard WorkerAll Markdown (`*.md`) files in this directory are treated as release notes -
6*c8dee2aaSAndroid Build Coastguard Workerexcept this file (`README.md`). As part of the release process, the contents of
7*c8dee2aaSAndroid Build Coastguard Workerthese files will be inserted into `RELEASE_NOTES.md`, and these files will be
8*c8dee2aaSAndroid Build Coastguard Workerdeleted.
9*c8dee2aaSAndroid Build Coastguard Worker
10*c8dee2aaSAndroid Build Coastguard WorkerThe release branch tool, which automatically does this aggregation, is described
11*c8dee2aaSAndroid Build Coastguard Workermore thoroughly in https://skia.googlesource.com/buildbot/+/refs/heads/main/sk/.
12*c8dee2aaSAndroid Build Coastguard Worker
13*c8dee2aaSAndroid Build Coastguard Worker## Markdown Support
14*c8dee2aaSAndroid Build Coastguard Worker
15*c8dee2aaSAndroid Build Coastguard WorkerNotes are free to use nearly all of the Markdown language. However, because they
16*c8dee2aaSAndroid Build Coastguard Workerwill be inserted into a larger release note file, certain guidelines should be
17*c8dee2aaSAndroid Build Coastguard Workerfollowed.
18*c8dee2aaSAndroid Build Coastguard Worker
19*c8dee2aaSAndroid Build Coastguard Worker1. Do not reference any local files in the `relnotes` directory.
20*c8dee2aaSAndroid Build Coastguard Worker
21*c8dee2aaSAndroid Build Coastguard Worker   So nothing like `![Tooltip](image.png)`.
22*c8dee2aaSAndroid Build Coastguard Worker
23*c8dee2aaSAndroid Build Coastguard Worker   References to URLs are allowed.
24*c8dee2aaSAndroid Build Coastguard Worker2. Do not use [headings](https://www.markdownguide.org/basic-syntax/#headings).
25*c8dee2aaSAndroid Build Coastguard Worker   Milestones in the top level release notes file (RELEASE_NOTES.md) use a
26*c8dee2aaSAndroid Build Coastguard Worker   single heading per milestone.
27*c8dee2aaSAndroid Build Coastguard Worker3. Do not use start your note with an
28*c8dee2aaSAndroid Build Coastguard Worker   [asterisk](https://www.markdownguide.org/basic-syntax/#unordered-lists) or
29*c8dee2aaSAndroid Build Coastguard Worker   other leading marks. These are automatically inserted by the script.
30*c8dee2aaSAndroid Build Coastguard Worker4. Horizontal rules will automatically be inserted between milestones when the
31*c8dee2aaSAndroid Build Coastguard Worker   release notes are generated
32