From ce72aa8fc05dd2632468d336afc636f6cc0cefb3 Mon Sep 17 00:00:00 2001
From: Haoxi Tan <haoxi.tan@gmail.com>
Date: Tue, 14 Jan 2020 14:40:56 +1000
Subject: [PATCH] added CONTRIBUTING and SECURITY md files in .github

---
 .github/CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++
 .github/SECURITY.md     |  9 +++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/SECURITY.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 000000000..ff482dcd9
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,32 @@
+# Contributing to BeEF
+
+Anyone is welcome to make BeEF better!
+
+Below are the steps needed to add code to BeEF on Github to the master branch:
+
+1. Clone the repository and create a new branch
+
+2. Write and commit your new code to that branch
+
+3. Run the existing tests to make sure they pass
+
+See https://github.com/beefproject/beef/wiki/BeEF-Testing for steps to do so
+
+TL;DR: 
+```
+bundle install --with test
+bundle exec rake spec
+```
+
+4. Write tests in RSpec for your new code (module, extension etc.)
+
+5. Run all tests again to make sure they all pass
+
+6. Edit existing wiki page / add a new one explaining the new features, including:
+	- sample usage (command snippets, steps and/or screenshots)
+	- internal working (code snippets & explanation)
+
+7. Submit a Pull Request, explaining:
+	- what you have added
+	- where to find help about it (link to wiki page)
+
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
new file mode 100644
index 000000000..a9c609e89
--- /dev/null
+++ b/.github/SECURITY.md
@@ -0,0 +1,9 @@
+send security bug reports to security@beefproject.com
+
+**A security report should include:**
+
+1. Description of the problem (what it is, what's the impact)
+
+2. Technical steps to replicate it (commands / screenshots)
+
+3. Actionable fix/recommendations to mitigate the issue