LogicAppsUX icon indicating copy to clipboard operation
LogicAppsUX copied to clipboard

docs(vscode): Add coding standards doc for VS Code extension

Open andrew-eldridge opened this issue 1 month ago • 1 comments

Commit Type

  • [ ] feature - New functionality
  • [ ] fix - Bug fix
  • [ ] refactor - Code restructuring without behavior change
  • [ ] perf - Performance improvement
  • [x] docs - Documentation update
  • [ ] test - Test-related changes
  • [ ] chore - Maintenance/tooling

Risk Level

  • [x] Low - Minor changes, limited scope
  • [ ] Medium - Moderate changes, some user impact
  • [ ] High - Major changes, significant user/system impact

What & Why

Add CODING_STANDARDS.md for the VS Code extension project as a reference for contributors and source of truth for coding standard rules

Impact of Change

  • Users: N/A
  • Developers: Adds documentation for coding standards on vs code extension project
  • System: N/A

Test Plan

  • [ ] Unit tests added/updated
  • [ ] E2E tests added/updated
  • [ ] Manual testing completed
  • [ ] Tested in:

Contributors

@andrew-eldridge @ccastrotrejo

andrew-eldridge avatar Nov 17 '25 20:11 andrew-eldridge

🤖 AI PR Validation Report

PR Review Results

Thank you for your submission! Here's detailed feedback on your PR title and body compliance:

PR Title

  • Current: docs(vscode): Add coding standards doc for VS Code extension
  • Issue: Title is specific, concise, and informative for this documentation change.
  • Recommendation: No changes needed.

Commit Type

  • Properly selected (docs)
  • Only one selected, which is correct.

Risk Level

  • Risk level set to Low. This matches the documentation-only change and label Risk:Low.

What & Why

  • Current: Add CODING_STANDARDS.md for the VS Code extension project as a reference for contributors and source of truth for coding standard rules
  • Issue: Clear and concise purpose is provided.
  • Recommendation: No changes needed.

Impact of Change

  • Impact described correctly:
    • Users: N/A
    • Developers: Adds documentation for coding standards on vs code extension project
    • System: N/A
  • Recommendation: No changes needed for impact description.

Test Plan

  • No testing required for documentation change. Test plan is appropriately left unchecked.

⚠️ Contributors

  • Contributors section lists @andrew-eldridge @ccastrotrejo. If PMs, Designers, or others contributed, consider acknowledging them here for completeness.

Screenshots/Videos

  • No screenshots/videos provided, which is correct for a documentation-only change.

Summary Table

Section Status Recommendation
Title
Commit Type
Risk Level
What & Why
Impact of Change
Test Plan
Contributors ⚠️ Consider crediting PMs/Designers if applicable
Screenshots/Videos

Everything is in order! If others contributed to the doc or its standards, consider tagging them for credit in Contributors. Otherwise, this PR meets all required standards for title and body format. Thank you for maintaining high-quality documentation!


Last updated: Mon, 24 Nov 2025 16:02:13 GMT

github-actions[bot] avatar Nov 17 '25 20:11 github-actions[bot]