Skip to content

Commit 4e34705

Browse files
authored
Add contributing guidelines to the Python Environments extension (#1012)
1 parent 2331581 commit 4e34705

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

CONTRIBUTING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing to Python Environments Extension
2+
3+
Thank you for your interest in contributing to the Python Environments extension! This guide will help you get started.
4+
5+
## Prerequisites
6+
7+
- Node.js (LTS version recommended)
8+
- npm
9+
- VS Code Insiders (recommended for development)
10+
- Git
11+
- Python
12+
13+
## Getting Started
14+
15+
1. **Clone the repository**
16+
```bash
17+
cd vscode-python-environments
18+
```
19+
20+
2. **Create a Python virtual environment**
21+
22+
3. **Install dependencies**
23+
```bash
24+
npm install
25+
```
26+
27+
4. **Build and watch**
28+
```bash
29+
npm run watch
30+
```
31+
32+
5. **Run tests**
33+
```bash
34+
npm run unittest
35+
```
36+
37+
## Development Workflow
38+
39+
### Running the Extension
40+
41+
1. Open the project in VS Code
42+
2. Press `F5` to launch the Extension Development Host
43+
3. The extension will be loaded in the new VS Code window
44+
45+
### Making Changes
46+
47+
- **Localization**: Use VS Code's `l10n` API for all user-facing messages
48+
- **Logging**: Use `traceLog` or `traceVerbose` instead of `console.log`
49+
- **Error Handling**: Track error state to avoid duplicate notifications
50+
- **Documentation**: Add clear docstrings to public functions
51+
52+
### Testing
53+
Run unit tests with the different configurations in the "Run and Debug" panel
54+
55+
## Contributor License Agreement (CLA)
56+
57+
This project requires contributors to sign a Contributor License Agreement (CLA). When you submit a pull request, a CLA bot will automatically check if you need to provide a CLA and guide you through the process. You only need to do this once across all Microsoft repositories.
58+
59+
## Code of Conduct
60+
61+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions.
62+
63+
## Questions or Issues?
64+
65+
- **Questions**: Start a [discussion](https://github.com/microsoft/vscode-python/discussions/categories/q-a)
66+
- **Bugs**: File an [issue](https://github.com/microsoft/vscode-python-environments/issues)
67+
- **Feature Requests**: Start a [discussion](https://github.com/microsoft/vscode-python/discussions/categories/ideas)
68+
69+
## Additional Resources
70+
71+
- [Development Process](https://github.com/Microsoft/vscode-python/blob/main/CONTRIBUTING.md#development-process)
72+
- [API Documentation](./src/api.ts)
73+
- [Project Documentation](./docs/projects-api-reference.md)
74+
75+
Thank you for contributing! 🎉

0 commit comments

Comments
 (0)