diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f88efc13..f368a10a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -71,6 +71,7 @@ VS Code v1.56 - docs(maintaining): add pull requests section #3378 @jsjoeio - docs(maintaining): add merge strategies section #3379 @jsjoeio - refactor: move default PR template #3375 @jsjoeio +- docs(contributing): add commits section #3377 @jsjoeio ### Development diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 22f4feb86..429f2a397 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -3,6 +3,7 @@ # Contributing - [Pull Requests](#pull-requests) + - [Commits](#commits) - [Requirements](#requirements) - [Development Workflow](#development-workflow) - [Updating VS Code](#updating-vs-code) @@ -23,9 +24,12 @@ you'd like to address unless the proposed fix is minor. In your Pull Requests (PR), link to the issue that the PR solves. -Please ensure that the base of your PR is the **master** branch. (Note: The default -GitHub branch is the latest release branch, though you should point all of your changes to be merged into -master). +Please ensure that the base of your PR is the **main** branch. + +### Commits + +We prefer a clean commit history. Please clean up your commits before marking your PR +ready for review. ## Requirements