autorest.typescript icon indicating copy to clipboard operation
autorest.typescript copied to clipboard

[RLC post GA work items] - Guidance for service teams about GA requirements on library testing, documentation and samples

Open qiaozha opened this issue 3 years ago • 1 comments

[RLC Archboard Discussions] New library release requirents

In order to ensure the quality and reliability of our SDKs we need to set requirements for all RLCs before they are released.

In general, engineering release requirements will be similar to other DPGs or HLCs we release covering:

  • Documentation (Readmes and generated docs)
  • Samples
  • Tests
  • Architecture board Naming approval (general naming and package naming)

Action items

  • [ ] Come up with a unified DPG and RLC exit criteria
  • [ ] If there is anything in the DPG+RLC exit criteria that doesn't apply or is missing for RLC, document it clearly in the onboarding guide and guidelines.

Notes:

  • Documentation exit criteria will be be influenced by the outcome of the docs discussion. In which we'll determine the level of generated documentation we want to offer for RLCs

qiaozha avatar May 27 '22 01:05 qiaozha

This item crosses all languages and we need to follow up with Laurrent on this. We could bring this up in sync-up meeting.

MaryGao avatar Jun 14 '22 00:06 MaryGao

we should update our onboard document to remind service team update the readme.md accross languages.

qiaozha avatar Dec 09 '22 03:12 qiaozha

already has this kind of hint in the onboard document.

qiaozha avatar Dec 15 '22 09:12 qiaozha