Azure / Azure/Connectors-NET-Samples

Update copilot-instructions: allow return value documentation

Offen Anfängerfreundlich
#12 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
C#
Sterne
3
Forks
3
Ø Merge
4 T. 14 Std.
Gemergte PRs (30 T.)
3

Beschreibung

## Problem

The `.github/copilot-instructions.md` currently says "Do NOT document return values" (no `` tag). This convention is inherited from the internal BPM repo and is inappropriate for a public samples repository where XML docs help developers understand the code.

## Proposed Changes

1. Update `.github/copilot-instructions.md` to remove the "Do NOT document return values" rule

## Context

The Samples repo has minimal public API surface, so the code change scope is small — primarily the copilot-instructions update.

See also: Azure/Connectors-NET-SDK#41

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Open .github/copilot-instructions.md and locate the rule that prohibits documenting return values. Remove that rule while preserving the surrounding instructions; done means the file no longer forbids return-value documentation. No test or run command is mentioned in the issue.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
78/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.