microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-10 14:16:15 -06:00
Code Issues Packages Projects Releases 177 Wiki Activity

Update Extension-API-process.md

Brian Clark 2018-07-02 11:41:13 -04:00 committed by GitHub
parent dbcc22af61
commit 95958f957d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Extension-API-process.md

@ -6,7 +6,7 @@ The goal of this process is to be transparent about how API is created, what pha
Weekly API call:
--
* During debt week, *everyone* that plans to work on API joins the call and presents his case. This call is about forming a shared understanding of the problem and helps us to understand whether the request is one that can safely be mapped onto prior art or will require custom constructs (which pretty much means more work).
* During debt week, *everyone* that plans to work on API joins the call and presents their case. This call is about forming a shared understanding of the problem and helps us to understand whether the request is one that can safely be mapped onto prior art or will require custom constructs (which pretty much means more work).
* We introduce a ‘api-finalization’ tag on GH to clearly identify the items that are about moving API from proposed to stable.
* Everyone who owns an open ‘api-finalization’ item for the current iteration needs to show up for the API call.
* Everyone who owns an open ‘api-finalization’ item scheduled for the iteration will present in week 1 of the iteration a concrete proposal and sample code showing how the API is being used. The sample code needs to be realistic. One-liners with artificial parameters etc. usually don’t cut it.
@ -19,4 +19,4 @@ Phases of a proposal
1. Idea -> _Ask yourself:_ How does this fit into the existing API? Is this a one-off-API that solves only your one problem? Does this reuse a concept, like providers or commands, or does this add a new concept?
2. Proposal -> _Ask yourself:_ Does my proposal alter existing API and/or violates it our [API guidelines](https://github.com/Microsoft/vscode/wiki/Extension-API-guidelines)?
3. Finalization -> _ Ask yourself:_ Do I have a non-trivial usage-sample for this? Do we use this new API ourselves?
3. Finalization -> _ Ask yourself:_ Do I have a non-trivial usage-sample for this? Do we use this new API ourselves?