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

Updated Extension API process (markdown)

Johannes Rieken 2018-06-29 15:00:00 +02:00
parent 5a901f358c
commit d4c8fa2fec
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Extension-API-process.md

@ -1,3 +1,16 @@
Extension API Process
=
The goal of this process is to be transparent about how API is created, what phases a proposal goes through, and to know what proposals are finalised when. Still, we want to maintain flexibility in making API.
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).
* 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.
* In each API call, we’ll work through the remaining open ‘api-finalization’ items before we look at ‘api-proposal’ items.
* If an API topic needs more time than what we have in the API call, we’ll schedule separate calls for these topics. These calls are open to everyone, just like the API call.