Skip to content

Improve CONTRIBUTING.md with dev setup links and docs guidance#5000

Merged
SergeyMenshykh merged 4 commits intomicrosoft:mainfrom
SergeyMenshykh:improve-contributing-guide
Mar 31, 2026
Merged

Improve CONTRIBUTING.md with dev setup links and docs guidance#5000
SergeyMenshykh merged 4 commits intomicrosoft:mainfrom
SergeyMenshykh:improve-contributing-guide

Conversation

@SergeyMenshykh
Copy link
Copy Markdown
Member

Summary

Improves the CONTRIBUTING.md with better discoverability for new contributors.

Changes

  • Development Setup section: Consolidated the old Development Scripts section into a new Development Setup section that includes:
    • Quick links to language-specific dev guides and coding standards (Python DEV_SETUP.md, CODING_STANDARD.md; .NET README.md, AGENTS.md)
    • Python build/test/lint commands alongside existing .NET commands
  • Documentation Contributions section: New section with guidance on:
    • Markdown link validation (CI link checker)
    • Host-agnostic, multi-language documentation style
    • Area-specific writing guidelines for durable agents docs

- Consolidate Development Scripts into a Development Setup section with
  quick links to language-specific dev guides and coding standards
- Add Python build/test/lint commands alongside existing .NET commands
- Add Documentation Contributions section with link checker, writing
  guidelines, and style guidance

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 31, 2026 16:08
@markwallace-microsoft markwallace-microsoft added the documentation Improvements or additions to documentation label Mar 31, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates CONTRIBUTING.md to make contributor onboarding easier by consolidating language-specific development guidance and adding documentation-contribution guidelines.

Changes:

  • Replaces “Development scripts” with “Development Setup”, adding quick links to Python/.NET guides and listing common build/test/lint commands.
  • Adds a “Documentation Contributions” section covering CI link checking and doc style guidance.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@SergeyMenshykh SergeyMenshykh force-pushed the improve-contributing-guide branch from 2ade307 to 7fde1ca Compare March 31, 2026 16:21
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@SergeyMenshykh SergeyMenshykh added this pull request to the merge queue Mar 31, 2026
Merged via the queue into microsoft:main with commit 3c727b5 Mar 31, 2026
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants