Browse Source

Update CONTRIBUTING.md advice on topic branches

Credit to @jmartin-r7 for the verbiage.
William Vu 8 months ago
parent
commit
8fcb6adde8
1 changed files with 5 additions and 3 deletions
  1. 5
    3
      CONTRIBUTING.md

+ 5
- 3
CONTRIBUTING.md View File

@@ -20,9 +20,11 @@ it into Metasploit's master branch.  If you do not care to follow these rules, y
20 20
 * **Do** stick to the [Ruby style guide] and use [Rubocop] to find common style issues.
21 21
 * **Do** follow the [50/72 rule] for Git commit messages.
22 22
 * **Do** license your code as BSD 3-clause, BSD 2-clause, or MIT.
23
-* **Do** create a [topic branch] to work on instead of working directly on `master` to preserve the
24
-  history of your pull request.  See [PR#8000] for an example of losing commit history as soon as
25
-  you update your own master branch.
23
+* **Do** create a [topic branch] to work on instead of working directly on `master`.
24
+  This helps protect the process, ensures users are aware of commits on the branch being considered for merge,
25
+  allows for a location for more commits to be offered without mingling with other contributor changes,
26
+  and allows contributors to make progress while a PR is still being reviewed.
27
+
26 28
 
27 29
 ### Pull Requests
28 30
 

Loading…
Cancel
Save