Commit Graph

39 Commits (ecce28e8b9106f98203cfbf1b675d7563081e4ee)

Author SHA1 Message Date
William Vu 72c88e5bde
Add note about release notes to CONTRIBUTING.md 2016-08-22 15:15:22 -05:00
William Vu 20c2a10e8a
Add note about issues to CONTRIBUTING.md 2016-06-30 15:14:59 -05:00
Brent Cook 68fdeb6031 suggest that we should include module docs and links to vuln software 2016-06-09 15:23:32 -05:00
HD Moore aea68adb77 Clarify that contributed code should be BSD/MIT 2016-02-22 16:29:13 -06:00
wvu-r7 ceb2eb7ffe Fix msftidy location
See #6052.
2016-01-21 13:30:55 -06:00
wvu-r7 8e5adfd79b Fix broken 50/72 rule link 2015-11-09 13:13:45 -06:00
Tod Beardsley 7697ff1295
Revert a couple of the suggested edits
In the main, though, the edits are good. Just disagree with a couple.

[See #5028]
2015-03-30 12:04:15 -05:00
Dillon Korman 0d110ad896 Update CONTRIBUTING.md
Grammar and style.
2015-03-28 15:11:05 -10:00
William Vu 6e08cc90db
Remove Road House reference
I'm not sure most people would get it.

It's not about getting kicked in the face by Patrick Swayze (RIP).
It's actually about being nice.

https://www.youtube.com/watch?v=l0aPIXy6PHM
2015-01-30 15:14:56 -06:00
Tod Beardsley dc7aff446a
Fix up README.md and CONTRIBUTING.md
* Specifically disclaim scripts
* Prefer end note links
* Pre-fill the issue submission form (check it out:
  http://r-7.co/MSF-BUGSv1 )
2015-01-30 14:28:39 -06:00
Tod Beardsley 1213aa1875
Missed one in CONTRIBUTING.md 2014-12-19 17:32:28 -06:00
Tod Beardsley 0da756bc96
Add a don't to CONTRIBUTING about merge messages
Also updated the wiki with an example message to allay any confusion
about avoiding the default merge message.

http://r-7.co/MSF-Landing-PRs

Also fix an italics where it should have been bold.
2014-11-18 13:35:18 -06:00
Tod Beardsley 9fcf87b27b Detypo CONTRIBUTING.md 2014-09-10 18:26:09 -05:00
Tod Beardsley 1938cd8663 Update CONTRIBUTING.md
Fix a sentence.
2014-09-10 15:22:24 -05:00
Tod Beardsley 877c2dd394 Update CONTRIBUTING.md
Redmine is on its way out. See here: 

https://github.com/rapid7/metasploit-framework/wiki/Decommissioning-Redmine
2014-09-10 15:21:47 -05:00
Tod Beardsley a80d4c25a6
Be more forceful about Rubocop in CONTRIBUTING.md 2014-08-14 11:51:44 -05:00
Jon Hart 73736c70b6 Add Rubocop to the Metasploit project
This is a work in progress because the code base is old and the style
varies wildly, however .rubocop.yml can (and should) be tweaked over
time to change standards as we see fit.  As it stands right now there
are few (if any) modules that pass Rubocop.
2014-07-15 10:43:08 -07:00
Christian Mehlmauer ff6607bd87 Correct documentation link
changed link from https://dev.metasploit.com/documents/api/ to https://dev.metasploit.com/api/
2014-06-02 22:37:20 +02:00
Tod Beardsley fe86886c29
Be very clear about Redmine's existence. 2014-04-18 10:01:54 -05:00
William Vu 531686c2c9
Change italics to bold 2014-04-05 22:21:44 -05:00
Tod Beardsley 22ff5e2b0b Add three more dos/donts to CONTRIBUTING.md
I've seen a couple PRs targeting the wrong branch. Many projects have a
workflow where PRs should hit `develop` or `release` or something, but
Metasploit-Framework wants PRs targeted against `master`.

Also, warn against fixing too much in one PR since those kinds of PRs
are a) harder to validate and b) might be all wrong anyway. We don't
want people committing a bunch of work when the fundamental approach
isn't going to fly.
2014-04-05 16:10:18 -05:00
Tod Beardsley 45086d01ce
Add a link to common coding mistakes 2014-03-04 14:06:34 -06:00
William Vu 3491a93f0a Add note about descriptive titles in bug reports 2014-03-04 13:16:55 -06:00
William Vu 3bbb2d628e Add note about topic branches 2014-03-04 13:05:50 -06:00
William Vu 79aa14235a Add note about the 50/72 rule 2014-03-04 12:46:42 -06:00
William Vu e8979ff892 Add note about PR titles 2014-03-04 12:44:12 -06:00
William Vu ca23f07da7 Change HTTP link to HTTPS
Doesn't redirect by default.
2014-03-04 12:22:14 -06:00
William Vu f8fb74a6d8 Add more examples of good contributions 2014-03-04 12:19:34 -06:00
William Vu 704d54fa0b Add missing period 2014-03-04 02:42:13 -06:00
William Vu 59dccdf94c Add an example of a good PR 2014-03-04 02:38:47 -06:00
William Vu d8314d36ab Add note about reporting vulns 2014-03-04 02:27:06 -06:00
Tod Beardsley defdf05f6d
Various and sundry text updates to CONTRIBUTING.md
Namely, all sentences should end with periods. Other light changes.
Please cover the rest of my comments mentioned on commit 30fec1af (or
argue with them) then PR away!
2014-03-03 14:39:40 -06:00
William Vu 30fec1af01 Add new CONTRIBUTING.md 2014-02-25 22:11:20 -06:00
Tod Beardsley 2861b70a34 Add a note about hooking msftidy 2013-05-28 10:44:23 -05:00
Nick Rivera ac3fe4c84e Update CONTRIBUTING.md 2013-05-10 23:15:29 +03:00
Tod Beardsley a7ea53ddf0 Update CONTRIBUTING.md
Add in a very short plea about repro steps.
2012-12-21 09:48:13 -06:00
Tod Beardsley a479d00130 Update CONTRIBUTING.md
Bold HACKING
2012-11-19 11:20:40 -06:00
Tod Beardsley 67d67a49df Implementing some, but not all, of the suggestions 2012-11-13 11:21:58 -06:00
Tod Beardsley 1cef61b148 Link README to CONTRIBUTING 2012-11-06 20:18:58 -06:00