Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

42 lines (34 loc) · 1.77 KB
Raw

Contribution

  • Please feel free to fork and submit pull requests
  • Feature requests can be added here

Prerequisites

  1. Node.js
  2. Python 2.7 or later (required only for testing the extension and running unit tests)
  3. Windows, OS X or Linux

Setup

git clone https://github.com/DonJayamanne/pythonVSCode
cd pythonVSCode
npm install

Development workflow

Incremental Build

Run the build Task from the Command Palette (short cut CTRL+SHIFT+B or ⇧⌘B)

Errors and Warnings

TypeScript errors and warnings will be displayed in VS Code in the Problems Panel (CTRL+SHIFT+M or ⇧⌘M)

Validate your changes

To test the changes you launch a development version of VS Code on the workspace vscode, which you are currently editing. Use the "Launch Extension" launch option.

Unit Tests

Run the Unit Tests via the "Launch Test" launch option. Currently unit tests only run on Travis

Requirements

  1. Ensure you have disabled breaking into 'Uncaught Exceptions' when running the Unit Tests
  2. For the linters and formatters tests to pass successfully, you will need to have those corresponding Python libraries installed locally

Debugging the extension

Standard Debugging

Clone the repo into any directory and start debugging. From there use the "Launch Extension" launch option.

Debugging the Python Extension Debugger

The easiest way to debug the Python Debugger (in our opinion) is to clone this git repo directory into your extensions directory. From there use the Launch Extension as debugserver launch option.