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

[RLC post GA work items] - RLCs guidelines

Open qiaozha opened this issue 3 years ago • 1 comments

[RLC Archboard Discussions] Guidelines for RLC

We have Azure SDK Guidelines to help SDK developers write libraries that align with the rest of the Azure SDK.

Since RLCs will be introducing new patterns, we'll need to add some RLC specific guidelines to help our SDK developers when releasing a new library. SDK authors will sometimes need to write helper functions to provide additional functionality and conveience to our customes, new guidelines for RLC will be scoped to the patterns and best practices when creating helper functions.

Action Items

  • [ ] Document best practices and patterns to write helper functions. Add these to the Guidelines.

Notes:

Since the only things that are going to potentially be hand written in RLCs are helper functions. We are not planning on writing guidelines for the auto-generated parts, for example how paths are generated, positional parameters for template paths, etc.

qiaozha avatar May 27 '22 01:05 qiaozha

This guidelines would be RLC customization doc. It should be in v1.1 and may be med priority

MaryGao avatar Jun 14 '22 00:06 MaryGao