Azure / Azure/azure-sdk-tools

azsdkcli cli-checks updates needed

Open
#11,644 0 comments 0 reactions 0 assignees View on GitHub
AzSDK Tools Agent azsdk-cli
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

- [ ] Figure out unit testing/best practices: https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2263695203
- [ ] Documentation on response parameters/Discussing parsing tool output and best ways to output it - do we want tools to just be a black box for the user?: https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2270766511
- [ ] Also related to above, for parsing tool output: https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2271140956
- [ ] Nit Go Abstract method: https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2270153425
- [ ] How will multiple workflows tie into the LanguageRepoService - do we want to differentiate?: https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2268196257
- [ ] On a similar note for the languageFactory -- https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2270733786
- [x] Nit - make check type an enum: https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2271133859
- [x] Do we make commands have a default value?: https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2270743695
- [ ] Do we want to use DefaultCommandResponse? https://github.com/Azure/azure-sdk-tools/pull/11432/files#r2270758074
- [ ] What should we name the subcommand and how should we allow people to specify which checks they want to run? (`azsdk check links` vs `azsdk azsdk package run-checks --check-type checkLinks`)
- [x] https://github.com/Azure/azure-sdk-tools/pull/11685#discussion_r2283587147
- [ ] https://github.com/Azure/azure-sdk-tools/pull/11747#discussion_r2298642467
- [ ] Next steps working examples needed: https://github.com/Azure/azure-sdk-tools/pull/11747#discussion_r2298650990

Contributor guide

Open the contributing guide

Research direction

Start by reading the unchecked review discussions in PR 11432 and the follow-up discussions in PRs 11685 and 11747. Clarify the command and check-selection design, workflow and factory behavior, response parsing, testing practices, and required examples; done means the open checklist items have decisions and corresponding updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.