-
Notifications
You must be signed in to change notification settings - Fork 292
Update contribution guidelines #6420
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
b31b146
move extensions guideline into it's own file
kristenwomack 61fe107
add initial azd-style-guide, add progress reports styles
kristenwomack af644bb
add guidance on color usage
kristenwomack 6146b44
Add cspell overrides for new documentation files
kristenwomack 636be43
Revert cspell override changes
kristenwomack d3ce003
Organize contribution docs and update links
kristenwomack 146fabf
Organize documentation: split into style-guidelines and extensions
kristenwomack 64d9927
Update cli/azd/docs/extensions/extensions-style-guide.md
kristenwomack e2add1b
Update cli/azd/docs/style-guidelines/azd-style-guide.md
kristenwomack bd604ea
Merge remote-tracking branch 'origin/main' into update-contribution-g…
kristenwomack d0f760d
fix merge conflict
kristenwomack c19862c
Update cli/azd/docs/style-guidelines/guiding-principles.md
kristenwomack 620407c
Simplify color documentation to reference helper functions (#6564)
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Extension Development Guidelines for `azd` | ||
|
|
||
| ## Overview | ||
|
|
||
| This guide provides design guidelines and best practices for developing extensions to the Azure Developer CLI (`azd`). Following these guidelines ensures that extensions maintain consistency with core `azd` functionality and provide a seamless user experience. | ||
|
|
||
| ## Design Guidelines for Extensions | ||
|
|
||
| ### 1. **Command Integration Strategy** | ||
|
|
||
| - New functionality should extend existing command categories | ||
| - Use a verb-first structure, where the primary action (e.g., add, create, delete, list) is the top-level command, and the target entity or context follows as an argument or subcommand. | ||
| - Example: `azd add <new-resource-type>` instead of `azd <new-resource-type> add` | ||
|
|
||
| ### 2. **Parameter and Flag Consistency** | ||
|
|
||
| - Reuse established parameter patterns across new commands | ||
| - Maintain consistent naming conventions (e.g., `--subscription`, `--name`, `--type`) | ||
| - Provide sensible defaults to reduce cognitive load | ||
|
|
||
| ### 3. **Help and Discoverability** | ||
|
|
||
| - Integrate new functionality into existing `azd help` structure | ||
| - Provide contextual guidance within established command flows | ||
| - Maintain documentation consistency across core and extended features | ||
|
|
||
| ### 4. **Template and Resource Integration** | ||
|
|
||
| - Leverage existing template system for new resource types | ||
| - Follow established template discovery and management patterns | ||
| - Integrate new resources into azd's resource lifecycle management | ||
|
|
||
| ### 5. **CI/CD and IaC Guidance** | ||
|
|
||
| - Provide support for GitHub Actions and Azure DevOps | ||
| - Consider support for a range of IaC providers (Bicep, Terraform, etc.) | ||
|
|
||
| ## Implementation Benefits | ||
|
|
||
| - **User Familiarity**: Builds on known command patterns and reduces learning curve | ||
| - **Discoverability**: New capabilities are found through existing workflows | ||
| - **Consistency**: Predictable behavior across all azd commands and extensions | ||
| - **Maintainability**: Systematic approach reduces complexity and technical debt | ||
| - **Extensibility**: Clear framework for adding capabilities without breaking existing patterns | ||
| - **Ecosystem Growth**: Provides foundation for third-party extensions and integrations | ||
|
|
||
| ## Future Considerations | ||
|
|
||
| This framework enables: | ||
|
|
||
| - Advanced workflow automation | ||
| - Enhanced developer productivity features | ||
| - Consistent user experience across all `azd` functionality | ||
| - Integration of new Azure services and capabilities | ||
| - Third-party extension development | ||
|
|
||
| --- | ||
|
|
||
| *For core design principles that apply to all `azd` functionality, see [guiding-principles.md](../style-guidelines/guiding-principles.md).* | ||
File renamed without changes.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.