1
- ## Contribution
2
- * Please feel free to fork and submit pull requests
1
+ # Contributing to the Python extension for Visual Studio Code
2
+
3
+ ## Contributing a pull request
3
4
4
5
### Prerequisites
5
6
13
14
14
15
### Setup
15
16
16
- ```
17
+ ``` shell
17
18
git clone https://github.com/microsoft/vscode-python
18
19
cd vscode-python
19
20
npm install
@@ -40,9 +41,10 @@ Use the `Launch Extension` launch option.
40
41
Run the Unit Tests via the ` Launch Test ` and ` Launch Multiroot Tests ` launch option.
41
42
Currently unit tests only run on [ Travis] ( https://travis-ci.org/Microsoft/vscode-python )
42
43
43
- _ Requirements_
44
+ #### Requirements
45
+
44
46
1 . Ensure you have disabled breaking into 'Uncaught Exceptions' when running the Unit Tests
45
- 2 . For the linters and formatters tests to pass successfully, you will need to have those corresponding Python libraries installed locally
47
+ 1 . For the linters and formatters tests to pass successfully, you will need to have those corresponding Python libraries installed locally
46
48
47
49
### Standard Debugging
48
50
@@ -59,7 +61,6 @@ From there use the ```Extension + Debugger``` launch option.
59
61
Information on our coding standards can be found [ here] ( https://github.com/Microsoft/vscode-python/blob/master/CODING_STANDARDS.md ) .
60
62
We have a pre-commit hook to ensure the code committed will adhere to the above coding standards.
61
63
62
-
63
64
## Development process
64
65
65
66
To effectively contribute to this extension, it helps to know how its
@@ -208,17 +209,11 @@ it should have an appropriate `closed-` label.
208
209
### Versioning
209
210
210
211
Starting in 2018, the extension switched to
211
- [ calendar versioning] ( http://calver.org/ ) from
212
- [ semantic versioning] ( https://semver.org/ ) since the extension
213
- auto-updates and thus there is no need to care about its version
214
- number in terms of backwards-compatibility. As such, the major version
215
- is the current year, the minor version is the week of the year, and
216
- the micro version is how many releases there have been that week
217
- (starting at 0). For example, a release made on July 2, 2018 would
218
- have a version number of ` 2018.27.0 ` . To easily calculate the first
219
- release of a week, you can run the following Python code:
220
- ``` python
221
- import datetime
222
- year, week, _ = datetime.date.today().isocalendar()
223
- print (f " { year} . { week} .0 " )
224
- ```
212
+ [ calendar versioning] ( http://calver.org/ ) since the extension
213
+ auto-updates and thus there is no need to track its version
214
+ number for backwards-compatibility. As such, the major version
215
+ is the current year, the minor version is the current month, and
216
+ the micro version is how many releases there have been that month in
217
+ the year (starting at 0). For example, the first release in July 2018
218
+ would be ` 2018.7.0 ` , the second release that month would be
219
+ ` 2018.7.1 ` , etc.
0 commit comments