68 Commits

Author SHA1 Message Date
adfoster-r7 e7eb5f760b Add additional markdown notes 2026-03-24 20:17:29 +00:00
DataExplorerX 1e769ad5aa Fix broken links in CONTRIBUTING.md code-free contributions section 2025-12-30 15:34:03 +05:30
Sebastien Dionne 77f760c1bf Fix typos in documentation 2025-10-05 12:01:16 -04:00
bwatters-r7 c40e4cc8bc Add section on Vibecoding and AI/LLM 2025-09-05 15:15:56 -05:00
jacob.w.pham.mil 0744c70c72 Implement maintainer feedback removed by accident from prior push
- Update Twitter references to X in Contact.md and README.md
- Add YouTube channel to Contact.md
- Remove IRC reference from CONTRIBUTING.md as requested
- Address all maintainer suggestions from PR review
2025-08-04 14:50:58 -04:00
jacob.w.pham.mil 9013316dbd Update communication channels in documentation
- Add GitHub Discussions and Slack as primary support channels
- Update README.md with current communication options
- Update Contact.md with organized channel hierarchy
- Update CONTRIBUTING.md to include GitHub Discussions
- Maintain references to existing IRC and mailing list channels

Addresses #20234
2025-07-30 22:32:53 -04:00
bwatters-r7 29084094b7 Add AI don't 2025-03-31 10:21:18 -05:00
bwatters-r7 9780732471 Add guidelines for expeditied module creation 2025-03-21 18:23:46 -05:00
Grant Willcox 1782ae1ff2 Fix up links within Wiki site to make them relative links where possible 2023-01-27 10:09:02 -06:00
Grant Willcox 6043d0ffba Update all links from Wiki site to new docs site. 2023-01-27 09:58:53 -06:00
Grant Willcox ae9e73d468 Fix up a typo in CONTRIBUTING.md 2021-06-05 14:31:15 -05:00
Tod Beardsley 9ead56f1a2 Mention the fact we're a CNA in CONTRIBUTING.md
This adds a line in the do's and don'ts about requesting a CVE.
2021-06-04 11:30:20 -05:00
Tod Beardsley 257c5b5aed Replace broken hard rule with a line of text 2021-06-04 11:22:55 -05:00
Alan Foster a9eadbe75c Update issue link in readme 2021-01-04 12:06:27 +00:00
Justin Steven effe43f6d7 Fix dead links 2020-10-24 19:33:23 +10:00
Adam Galway d428e00b35 adds additional clarification and spelling changes 2020-02-04 17:02:46 +00:00
Adam Galway 375b13733c cleans up contributer guide 2020-02-03 17:29:58 +00:00
William Vu 92cae35e72 Fix typo 2019-10-11 10:50:25 -05:00
Jeffrey Martin c139786240 add some requests about how to use PRs efficiently 2019-10-11 10:43:23 -05:00
Jeffrey Martin fe027e4ee0 correct PR queue link text 2019-10-11 10:30:37 -05:00
William Vu 21df0ff4bb Fix "mutliple" typo in CONTRIBUTING.md 2019-09-25 11:14:08 -05:00
William Vu dbc0811ba4 Fix italics to bold
Damn you, Slack.
2019-04-30 17:13:38 -05:00
William Vu 9c3bc0ac67 Add note about WIP PRs to CONTRIBUTING.md 2019-04-30 17:05:12 -05:00
William Vu 8fcb6adde8 Update CONTRIBUTING.md advice on topic branches
Credit to @jmartin-r7 for the verbiage.
2019-04-12 12:39:59 -05:00
Caitlin Condon 16d7c0530a Update CONTRIBUTING.md 2018-12-13 09:35:37 -06:00
Aaron Soto 84e4cd9a0c Update CONTRIBUTING.md
Updated vuln disclosure, removed deprecated instructions, added links to more recent examples
2018-12-12 15:01:21 -06:00
Brent Cook be8b826ea3 include example of why PRs from master are bad 2018-05-08 17:54:14 -05:00
Brady Sullivan 593813cdef Fix small grammar issues in ms08_067 and ms17_010
Also includes very small changes to improve punctuation consistency
within CONTRIBUTING.md
2018-01-15 19:32:44 -08:00
Brent Cook b9b779da9e update references to sourceforge ML 2017-08-20 13:23:54 -05:00
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