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

chore: document unstable new feature processes (#5976)

Browse Source 
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
This commit is contained in:
Yoshiya Hinosawa 2024-09-13 14:35:36 +09:00 committed by GitHub
parent c6d1ab2d68
commit 75a50aecf7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.github/CONTRIBUTING.md vendored
View File

@ -38,6 +38,32 @@ When new features are accepted, they are initially accepted as 'unstable'
features in the Standard Library. These features are later stabilized after
receiving sufficient feedback from the community and the core team.
### New features in stable packages (version >= 1.0.0)
If you suggest new APIs in stable packages, which have the version above 1.0.0,
you need to implment that API in the file paths of the pattern
`./unstable_<api_name>`, and the API shouldn't exported from the root module
(`mod.ts`). This is to make it clear which API is stable and which is not.
Example:
```
encoding
├── base32.ts <--- stable API
├── base64.ts <--- stable API
├── base64url.ts <--- stable API
├── hex.ts <--- stable API
├── mod.ts <--- stable API
├── unstable_base32_stream.ts <--- unstable API
├── unstable_base32hex.ts <--- unstable API
└── unstable_base32hex_stream.ts <--- unstable API
```
### New features in unstable packages (version < 1.0.0)
There's no special rules to new features in unstable packages. Write new APIs
and send a pull request.
## Deprecations
1. See the [deprecation policy](/README.md#deprecation-policy) for how