From 62b5fadd9c5fad1fae7c56f7bb51e50b09559663 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 12 May 2021 15:23:45 -0700 Subject: [PATCH 1/2] docs(contributing): add commits section --- CHANGELOG.md | 1 + docs/CONTRIBUTING.md | 10 +++++++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f88efc1..f368a10a 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 22f4feb8..429f2a39 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 From 60d71fee6f9bd839b715a8c49726debd5c273664 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 12 May 2021 15:40:21 -0700 Subject: [PATCH 2/2] docs(contributing): add commits section --- docs/CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 429f2a39..5ebe1bc8 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -28,8 +28,7 @@ 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. +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. ## Requirements