From be8b826ea31298e6d223a5e25cacd453c0ca9ece Mon Sep 17 00:00:00 2001 From: Brent Cook Date: Tue, 8 May 2018 17:54:14 -0500 Subject: [PATCH] include example of why PRs from master are bad --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69dfe85dc..dc315eb5c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,8 +36,13 @@ and Metasploit's [Common Coding Mistakes]. * **Do** get [Rubocop] relatively quiet against the code you are adding or modifying. * **Do** follow the [50/72 rule] for Git commit messages. * **Don't** use the default merge messages when merging from other branches. -* **Do** create a [topic branch] to work on instead of working directly on `master`. * **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`. + If you do not send a PR from a topic branch, the history of your PR will be + lost as soon as you update your own master branch. See + https://github.com/rapid7/metasploit-framework/pull/8000 for an example of + this in action. + ### Pull Requests