Azure / Azure/azure-sdk-tools

SDK Review Meeting prerequisites verification and automated messages

Open
#7,676 12 comments 0 reactions 0 assignees View on GitHub
Epic Scheduling tool
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

**Requirement:** Trends in SDK Review Meetings shows that some service partners are scheduling SDK reviews far in advance and then either (a) showing up to the meeting and not completing all of the prerequisites (b) cancelling at the last minute which does not give enough time for another team to take that slot

Prerequisites Intro: (Beta, service team has changed scope significantly, service partner has not been to an arch board session in around 2 years)

1. API Readiness is complete (which means that API Stewardship Board has signed off on the API version).
2. Generate the API Views for SDK review. (1 API View be prepared) - use the APIViews from the spec PR
4. Hero/Champion scenario link has been uploaded to the meeting invite.
5. Write samples for generated library. (Samples written for 1 APIView) - Create issue to confirm that samples are added to APIView.

Prerequisites SDK Review - Stable SDKs

1. API Readiness is complete (which means that API Stewardship Board has signed off on the API version).
2. API Views are autogenerated from PRs from the language repos.
3. Hero/Champion scenario link has been uploaded to the meeting invite.
4. Write samples for generated library.

TODO: Determine how to handle service partners who do not use our repos for their SDK code.
TODO: Adding non-Tier 1 languages to the data plane SDK release milestone to release planner.
TODO: On scheduling side surface the languages that were selected in the release planner.

**Updates by James**

Pain points driving need for verification
- The SDK review board often wastes time joining meetings when prerequisites aren’t met causing the need for teams to reschedule
- Ronnie has to manually check that prerequisites are completed prior to the meetings and will email them if they are not completed, this is a frequent occurrence, (about once a week teams will not have completed prerequisites)
- Teams often enter incorrect information into the scheduler such as a GitHub link into SDK Languages/Platforms for SDK Review or the API view link is missing a diff

Changes to power app UX
- [ ] In the” Hero scenarios Link” section, ghost text should say 2 business days, not 48 hours (Ghost text only shows up when Beta is selected, not Stable)
- [ ] In the API view link box ghost text should say 2 business days, not 48 hours (Ghost text only shows up when Stable is selected, not Beta)
- [ ] Make the “Description” box required
- [ ] Should be able to add a distribution list to meeting attendees i.e. Azure SDK pm
- [ ] For beta SDK meetings only one language API view link is required\
- [ ] In the SDK Languages/Platforms for SDK Review box, check the URL for a valid API view link and display message “Not a valid API view link, please visit (documentation) to learn more” if an API view link isn’t detected
- [ ] This is not a hard requirement but in a perfect world: if a user selects Stable the API view link should also have "diff" in it
- [ ] When editing an SDK Languages/Platforms for SDK Review link there is an update button, this however doesn't update the form unless the main update button is pushed to update the entire form. This has caused confusion where teams think they updated the form but it didn't save the changes. We could add a warning when someone tries to exit the page that there are unsaved details.

Requirements for verification and follow up

- [ ] Send a reminder email a week (or somewhere around there) prior to the meeting reminding them that they are still missing materials and warning that the meeting will need to be canceled and rescheduled if not added. See [email templates](https://microsoft-my.sharepoint.com/:w:/p/jamesferry/ETYprrCs_ttFkb4F9Mm_WeUBZBB6tyfV70INsUPhN3o5lQ?e=TgiiTd) cc this alias in the email azsdkarch-help@microsoft.com
- [ ] Two business days prior to the meeting start send an email saying the meeting has been canceled because the required materials were not added. Allow the user to reschedule the meeting by clicking a link
(Ideally this would have saved the meeting details from the past meeting they scheduled so they don’t have to go through the form again) See [email templates](https://microsoft-my.sharepoint.com/:w:/p/jamesferry/ETYprrCs_ttFkb4F9Mm_WeUBZBB6tyfV70INsUPhN3o5lQ?e=TgiiTd) cc this alias in the email azsdkarch-help@microsoft.com
- [ ] There should be an ability for these checks to be overridden by the SDK review board if they found an acceptable exception
- [ ] A message should pop up when a meeting form is submitted informing them which items are missing and that they need to include them at least 2 business days before the meeting or it will be canceled.

An FAQ page could be made if someone (maybe from the emails or on the scheduler app) selects they can't complete the requirements, they could reach out with a requirements exception if these don't help.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are identified. Start by locating the scheduler or Power App meeting form and the SDK review meeting workflow, then confirm the scope with maintainers because the issue combines UX validation, automated reminders and cancellation, overrides, rescheduling, and FAQ work. Done means the agreed prerequisites are verified and the corresponding messages and workflow changes are tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.