Update CONTRIBUTING.md advice on topic branches

Credit to @jmartin-r7 for the verbiage.
master
William Vu 2019-04-12 12:32:41 -05:00
parent 7b09947551
commit 8fcb6adde8
1 changed files with 5 additions and 3 deletions

View File

@ -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** 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** follow the [50/72 rule] for Git commit messages.
* **Do** license your code as BSD 3-clause, BSD 2-clause, or MIT. * **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 * **Do** create a [topic branch] to work on instead of working directly on `master`.
history of your pull request. See [PR#8000] for an example of losing commit history as soon as This helps protect the process, ensures users are aware of commits on the branch being considered for merge,
you update your own master branch. 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 ### Pull Requests