Skip to content

Commit fafd0f8

Browse files
authored
Update contributing guide (microsoft#687)
1 parent b45aae3 commit fafd0f8

File tree

1 file changed

+23
-33
lines changed

1 file changed

+23
-33
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ for a release are tracked in a
9393
[milestone](https://github.com/Microsoft/vscode-python/milestones)
9494
(which is actively updated as plans change).
9595

96-
The overall schedule for a release is to code freeze for on the last
96+
The overall schedule for a release is to feature freeze for on the last
9797
Monday of the month to coincide with Visual Studio Code's code freeze.
9898
We then aim to release later that week so the latest version of the
9999
extension is already live by the time Visual Studio Code launches
@@ -104,16 +104,10 @@ between scheduled releases as necessary.
104104
All development is actively done in the `master` branch of the
105105
repository. It is what allows us to have an
106106
[insiders build](#insiders-build) which is expected to be stable at
107-
all times. We do keep the previous release as a branch in case the
107+
all times. We do keep the most recent release as a branch in case the
108108
need for a bugfix release arises. But once a new release is made we
109-
convert the older branch into a tag and delete the branch as
110-
Visual Studio Code's automatic updating makes keeping old versions
111-
around unnecessary.
112-
113-
Since we try to spend about 25% of our development time fixing bugs
114-
and removing technical debt, the week of a release is mostly spent
115-
focusing on that topic. That way we don't ignore the health of the
116-
code base by accidentally focusing on new features exclusively.
109+
delete the older release branch (all releases are appropriately
110+
tagged, so history is lost).
117111

118112
### Issue triaging
119113

@@ -142,21 +136,17 @@ lexicographically sort from earliest stage to latest stage). The
142136
suffix term for each label then specifies what is currently blocking
143137
the issue from being closed.
144138

145-
* `1-`
146-
* [`decision`](https://github.com/Microsoft/vscode-python/labels/awaiting%201-decision):
147-
The issue is a feature enhancement request and a decision has not
148-
been made as to whether we would accept a pull request
149-
implementing the enhancement
150-
* [`more info`](https://github.com/Microsoft/vscode-python/labels/awaiting%201-more%20info):
151-
We need more information from the OP (original poster)
152-
* [`verification`](https://github.com/Microsoft/vscode-python/labels/awaiting%201-verification):
153-
We need to verify that the issue can be replicated
139+
* [`1-decision`](https://github.com/Microsoft/vscode-python/labels/awaiting%201-decision):
140+
The issue is a feature enhancement request and a decision has not
141+
been made as to whether we would accept a pull request
142+
implementing the enhancement
143+
* [`1-more info`](https://github.com/Microsoft/vscode-python/labels/awaiting%201-more%20info):
144+
We need more information from the OP (original poster)
145+
* [`1-verification`](https://github.com/Microsoft/vscode-python/labels/awaiting%201-verification):
146+
We need to verify that the issue is reproducible
154147
* [`2-PR`](https://github.com/Microsoft/vscode-python/labels/awaiting%202-PR):
155148
The issue is valid and is now awaiting a fix to be created and
156149
merged into the `master` branch
157-
* [`4-validation`](https://github.com/Microsoft/vscode-python/labels/awaiting%204-validation):
158-
A pull request has been merged and resolution of the issue should be
159-
independently validated
160150

161151
#### Closed issues
162152

@@ -168,22 +158,21 @@ it should have an appropriate `closed-` label.
168158

169159
1. Check that there is an issue corresponding to what the pull request
170160
is attempting to address
171-
* If an issue exists, make sure it has reached the stage of being
172-
labeled `awaiting 2-PR`
161+
* If an issue exists, make sure it has reached the stage of
162+
`awaiting 2-PR`
173163
* If no issue exists, open one and wait for it to reach the
174164
`awaiting 2-PR` stage before submitting the pull request
175-
1. Open the pull request, mentioning the appropriate issue(s) in the
165+
1. Create the pull request, mentioning the appropriate issue(s) in the
176166
pull request message body
177167
* The pull request is expected to have appropriate unit tests
178168
* The pull request must pass its CI run before merging will be
179169
considered
180-
* Code coverage is expected to not worsen
170+
* Code coverage is expected to (at minimum) not worsen
181171
1. Make sure all status checks are green (e.g. CLA check, CI, etc.)
182172
1. Address any review comments
183173
1. [Maintainers only] Merge the pull request
184174
1. [Maintainers only] Update affected issues to be:
185175
1. Closed (with an appropriate `closed-` label)
186-
1. The stage is set to `awaiting 4-validation`
187176
1. The issue(s) are attached to the current milestone
188177
1. Register OSS usage
189178
1. Email CELA about any 3rd-party usage changes
@@ -194,11 +183,12 @@ Starting in 2018, the extension switched to
194183
[calendar versioning](http://calver.org/) since the extension
195184
auto-updates and thus there is no need to track its version
196185
number for backwards-compatibility. As such, the major version
197-
is the current year, the minor version is the current month, and
198-
the micro version is how many releases there have been that month in
199-
the year (starting at 0). For example, the first release in July 2018
200-
would be `2018.7.0`, the second release that month would be
201-
`2018.7.1`, etc.
186+
is the current year, the minor version is the month when feature
187+
freeze was reached, and the micro version is how many releases there
188+
have been since that feature freeze (starting at 0). For example
189+
the release made when we reach feature freeze in July 2018
190+
would be `2018.7.0`, and if a second release was necessary to fix a
191+
critical bug it would be `2018.7.1`.
202192

203193
## Insiders Build
204194

@@ -214,7 +204,7 @@ file, please follow the instructions on
214204
[this page](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix)
215205
to install the extension.
216206

217-
The insiders build of the extension ...:
207+
The insiders build of the extension:
218208

219209
* Will be replaced with new releases published onto the
220210
[VS Code Marketplace](https://marketplace.visualstudio.com/VSCode).

0 commit comments

Comments
 (0)