Skip to content

Conversation

@k-a-rthik
Copy link

make contributing more friendlier and beginner friendly.

Condensed the contributing guidelines by removing redundant sections and streamlining the content for clarity.

…ng more friendlier and beginner friendly.

Condensed the contributing guidelines by removing redundant sections and streamlining the content for clarity.
Copy link

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

This PR significantly refactors the CONTRIBUTING.md documentation to make it more accessible and beginner-friendly by condensing content, removing verbose explanations, and streamlining the structure. The changes reduce the file from 325 lines to 32 lines while preserving essential information.

Key changes:

  • Simplified issue creation guidelines into a concise checklist format
  • Condensed development setup and testing instructions into brief commands
  • Removed detailed architecture documentation, TSX prompt development guides, and API update procedures

### Requirements
- Node 22.x
- Python 3.10–3.12
- Windows users: `Set-ExecutionPolicy Unrestricted`
Copy link

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

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

The instruction to run Set-ExecutionPolicy Unrestricted without admin context is a security risk. This should specify running as administrator and recommend using RemoteSigned instead of Unrestricted for better security: Set-ExecutionPolicy RemoteSigned -Scope CurrentUser (user level) or mention requiring admin privileges for system-wide changes.

Suggested change
- Windows users: `Set-ExecutionPolicy Unrestricted`
- Windows users: To allow running local PowerShell scripts, run `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser` in a PowerShell window.
If you need to set the policy system-wide, run PowerShell as administrator and use `Set-ExecutionPolicy RemoteSigned` (without `-Scope CurrentUser`).

Copilot uses AI. Check for mistakes.
Comment on lines +3 to +4
## Creating Good Issues
Before opening a new issue, search [open issues](https://github.com/microsoft/vscode/issues) to check for duplicates.
Copy link

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

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

The removal of extensive architecture documentation (Project Architecture, Layers, Runtimes, Contributions and Services sections) eliminates critical information for contributors wanting to understand the codebase structure. Consider adding a reference to .github/copilot-instructions.md or other architecture documentation rather than completely removing this guidance.

Copilot uses AI. Check for mistakes.
There are unit tests which run in Node.JS:

```
Run:
Copy link

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

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

The removal of simulation test documentation eliminates important context about cache population requirements, baseline updates, and the distinction between different test types. Contributors need to understand that simulation tests require VS Code team member involvement for cache layer creation and may fail without proper cache population. At minimum, link to detailed testing documentation.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant