Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-21 20:50:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

chore: document how to document unstable APIs (#5484)

Browse Source
This commit is contained in:
Asher Gomez 2024-07-19 13:59:38 +10:00 committed by GitHub
parent 0cf043102e
commit 00645f09bf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
.github/CONTRIBUTING.md vendored
View File

@ -133,3 +133,23 @@ delimiter. E.g.
* ```
*/
````
### Notices for unstable APIs
Each unstable API must have the
[`@experimental`](https://tsdoc.org/pages/tags/experimental/) TSDoc tag and a
[warning alert](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)
after the starting description.
```ts
/**
* <description>
*
* > [!WARNING]
* > **UNSTABLE**: New API, yet to be vetted.
*
* @experimental
*
* ...
*/
```