From e023e34a70eb455b09c4a361c63b638b6006d65d Mon Sep 17 00:00:00 2001 From: Jeffrey Martin Date: Fri, 12 Apr 2019 15:22:30 -0500 Subject: [PATCH] Land #11720, Update CONTRIBUTING.md advice on topic branches --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b69a1edd9e..ca2045aca8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,9 +20,11 @@ it into Metasploit's master branch. If you do not care to follow these rules, y * **Do** stick to the [Ruby style guide] and use [Rubocop] to find common style issues. * **Do** follow the [50/72 rule] for Git commit messages. * **Do** license your code as BSD 3-clause, BSD 2-clause, or MIT. -* **Do** create a [topic branch] to work on instead of working directly on `master` to preserve the - history of your pull request. See [PR#8000] for an example of losing commit history as soon as - you update your own master branch. +* **Do** create a [topic branch] to work on instead of working directly on `master`. + This helps protect the process, ensures users are aware of commits on the branch being considered for merge, + allows for a location for more commits to be offered without mingling with other contributor changes, + and allows contributors to make progress while a PR is still being reviewed. + ### Pull Requests