Azure / Azure/azure-sdk-tools

Add Readme guidelines/check in the data plane SDK app

Open
#7,962 0 comments 0 reactions 1 assignee Assigned to @maririos View on GitHub
Engagement Experience
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

Currently we have guidence for changelogs and release notes. We should also include the Readmes for each language repo.
- General SDK documentation: [General Guidelines: Documentation | Azure SDKs](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fazure.github.io%2Fazure-sdk%2Fgeneral_documentation.html&data=05%7C02%7Cmariari%40microsoft.com%7Cf2c3dd4dff8b4441c57d08dc4e8fe154%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638471627069167542%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=%2FCnkk8jFQTBfehPPdkwNNoMhYK4lpk2XTf%2FZa6NqlEc%3D&reserved=0)
o The first bullet point points to a general readme example
- C#: [.NET Azure SDK Design Guidelines | Azure SDKs](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fazure.github.io%2Fazure-sdk%2Fdotnet_introduction.html%23dotnet-repository-readme&data=05%7C02%7Cmariari%40microsoft.com%7Cf2c3dd4dff8b4441c57d08dc4e8fe154%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638471627069180342%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=ysHasNMTRaA%2Bt1ZPrYyNyk8bTVdHOqnJ0XKFWWJAdRY%3D&reserved=0)
- Python:
o [Python Guidelines: Documentation | Azure SDKs](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fazure.github.io%2Fazure-sdk%2Fpython_documentation.html&data=05%7C02%7Cmariari%40microsoft.com%7Cf2c3dd4dff8b4441c57d08dc4e8fe154%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638471627069184520%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=eTdbBRMQeWOw0stlco6AI4RpJkOFGPCzVQtCT9LyhV4%3D&reserved=0): The first bullet point mentions the README
o [Python Guidelines: API Design | Azure SDKs](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fazure.github.io%2Fazure-sdk%2Fpython_design.html%23documentation-style&data=05%7C02%7Cmariari%40microsoft.com%7Cf2c3dd4dff8b4441c57d08dc4e8fe154%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638471627069188486%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=vxB6ZeApEf4yO4ggp19gCB6K6IajSaH6MJS3o%2B7VRxM%3D&reserved=0)
- Java: Looks like their docs are missing README information.
- JS/TS: [TypeScript Guidelines: Documentation | Azure SDKs](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fazure.github.io%2Fazure-sdk%2Ftypescript_documentation.html&data=05%7C02%7Cmariari%40microsoft.com%7Cf2c3dd4dff8b4441c57d08dc4e8fe154%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638471627069192435%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=SiUUVyTsZusfePnCdi4AIgvX7W7PMP39mGwyVcX7Xy4%3D&reserved=0)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.