Update copilot-instructions: allow return value documentation
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- csharp
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
Problem
The .github/copilot-instructions.md currently says "Do NOT document return values" (no <returns> 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
- Update
.github/copilot-instructions.mdto 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
- Dominant language
- C#
- Stars
- 3
- Forks
- 3
- Avg merge
- 58m
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/Connectors-NET-Samples
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Azure/Connectors-NET-Samples#5 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Azure/Connectors-NET-Samples#47 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Azure/Connectors-NET-Samples#46 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
Azure/Connectors-NET-Samples#45 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Azure/Connectors-NET-Samples#13 ·
Maintainers usually reply within 1 day
All issues in Azure/Connectors-NET-Samples
Similar issues
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
spectreconsole/spectre.console#2221 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
area/navigationview 🧭 difficulty/starter 🚀 good first issue kind/bug platform/all project/navigation-lifecycle 🧬 triage/untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
unoplatform/uno#24925 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
PhilippC/keepass2android#3315 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
DamianEdwards/ghcp-spend-tray#39 ·
Maintainers usually reply within 1 day