Skip to content

Commit 72c88e5

Browse files
committed
Add note about release notes to CONTRIBUTING.md
1 parent 3b3b472 commit 72c88e5

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ and Metasploit's [Common Coding Mistakes].
4646
* **Do** include [console output], especially for witnessable effects in `msfconsole`.
4747
* **Do** list [verification steps] so your code is testable.
4848
* **Do** [reference associated issues] in your pull request description
49+
* **Do** write [release notes] once a pull request is landed
4950
* **Don't** leave your pull request description blank.
5051
* **Don't** abandon your pull request. Being responsive helps us land your code faster.
5152

@@ -108,6 +109,7 @@ already way ahead of the curve, so keep it up!
108109
[console output]:https://help.github.com/articles/github-flavored-markdown#fenced-code-blocks
109110
[verification steps]:https://help.github.com/articles/writing-on-github#task-lists
110111
[reference associated issues]:https://github.com/blog/1506-closing-issues-via-pull-requests
112+
[release notes]:https://github.com/rapid7/metasploit-framework/wiki/Adding-Release-Notes-to-PRs
111113
[PR#2940]:https://github.com/rapid7/metasploit-framework/pull/2940
112114
[PR#3043]:https://github.com/rapid7/metasploit-framework/pull/3043
113115
[pre-commit hook]:https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb

0 commit comments

Comments
 (0)