Skip to content

Commit 509d91d

Browse files
authored
Merge pull request #3377 from cdr/jsjoeio/docs-clean-commits
docs(contributing): add commits section
2 parents a7cf990 + 60d71fe commit 509d91d

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ VS Code v1.56
7171
- docs(maintaining): add pull requests section #3378 @jsjoeio
7272
- docs(maintaining): add merge strategies section #3379 @jsjoeio
7373
- refactor: move default PR template #3375 @jsjoeio
74+
- docs(contributing): add commits section #3377 @jsjoeio
7475

7576
### Development
7677

docs/CONTRIBUTING.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# Contributing
44

55
- [Pull Requests](#pull-requests)
6+
- [Commits](#commits)
67
- [Requirements](#requirements)
78
- [Development Workflow](#development-workflow)
89
- [Updating VS Code](#updating-vs-code)
@@ -23,9 +24,11 @@ you'd like to address unless the proposed fix is minor.
2324

2425
In your Pull Requests (PR), link to the issue that the PR solves.
2526

26-
Please ensure that the base of your PR is the **master** branch. (Note: The default
27-
GitHub branch is the latest release branch, though you should point all of your changes to be merged into
28-
master).
27+
Please ensure that the base of your PR is the **main** branch.
28+
29+
### Commits
30+
31+
We prefer a clean commit history. This means you should squash all fixups and fixup-type commits before asking for review (cleanup, squash, force-push). If you need help with this, feel free to leave a comment in your PR and we'll guide you.
2932

3033
## Requirements
3134

0 commit comments

Comments
 (0)