Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (67 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

96 lines (67 loc) · 4.38 KB

Contributing to Azure FinOps Agent

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

How to Contribute

  1. Fork this repository.
  2. Create a feature branch (git checkout -b feature/my-feature).
  3. Commit your changes (git commit -am 'Add my feature').
  4. Push to the branch (git push origin feature/my-feature).
  5. Open a Pull Request.

Branch Naming Convention

New branches must use one of two prefixes (kept simple on purpose):

Prefix Use
feature/<short-desc> new functionality, refactor, docs, chore
bug/<short-desc> bug fix or hotfix

Pushing to any non-main branch deploys it to the test slot at https://finops-agent-container-test.azurewebsites.net via feature.yml. The branch name is shown in the top-right badge of the running app.

Development Setup

Prerequisites

Building & Running

  • Backend: .NET 10 minimal API in src/Dashboard/
  • Frontend: Vue 3 + Vite SPA in src/Dashboard/frontend/
# One-time: Create Entra ID app registration
cd src/Dashboard
.\setup-entra-app.ps1
# Store the output ClientId/ClientSecret via dotnet user-secrets (see README → Running Locally)

# Build the Vue frontend to wwwroot/
cd frontend
npm install
npm run build

# Start the .NET backend (must set Development environment)
cd ..
$env:ASPNETCORE_ENVIRONMENT="Development"
dotnet run --urls "http://localhost:5000"

# Open http://localhost:5000

Important: You must set ASPNETCORE_ENVIRONMENT=Development before running. Without it, the app defaults to Production and the OAuth redirect_uri will mismatch.

Secrets

Local dev secrets are managed via dotnet user-secrets — they live outside the repo and cannot be committed by accident. See README → Running Locally for the full list of keys.

  • appsettings.json — base config with empty placeholders (committed)
  • appsettings.Production.json — production secrets (gitignored, App Service only)

Project Structure

src/Dashboard/
├── Program.cs              # App composition, middleware, endpoint mapping
├── AI/                     # Copilot SDK session factory, chat SSE endpoint, tools
├── Auth/                   # Microsoft Entra ID OAuth, session token store, persistent identity
├── Endpoints/              # Sessions, downloads, uploads, SEO/meta endpoints
├── Infrastructure/         # HTTP helper, temp file helper
├── Observability/          # OpenTelemetry sources/meters
├── frontend/src/components/  # Vue 3 components (ChatView, Dashboard)
├── Dockerfile              # Multi-stage build (frontend + .NET + Python + OTel)
└── setup-entra-app.ps1     # Entra ID app registration setup (one-time)

Code Conventions

  • Backend: Clean C# following Microsoft coding conventions, .NET 10 APIs, Vue 3 Composition API with <script setup>
  • Tools: Return raw API JSON (let the LLM interpret it), use string parameters, keep tools simple. All tools are read-only — write operations are blocked at the HTTP client level.
  • Frontend: Modern JavaScript, ECharts for visualization, SSE for streaming

See the README for full architecture details.

Reporting Issues

Please use GitHub Issues to report bugs or request features.