From ce72aa8fc05dd2632468d336afc636f6cc0cefb3 Mon Sep 17 00:00:00 2001 From: Haoxi Tan Date: Tue, 14 Jan 2020 14:40:56 +1000 Subject: [PATCH 1/6] 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 From 17b0949f024ec5ac15bf92e6629f9334ff25c690 Mon Sep 17 00:00:00 2001 From: Haoxi Tan Date: Tue, 14 Jan 2020 14:57:58 +1000 Subject: [PATCH 2/6] added pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..5f854b370 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +Thanks for submitting a PR! Please fill in this template where appropriate: + +## Category: (Bug | module | extension | core functionality | documentation) + +## Feature/Issue Description + +This module is added to ... + +## Changes made and file paths + +Added module example_module to modules/misc/example_module.. + +## Improvements made + +## Relevant links + +e.g. link to wiki page \ No newline at end of file From 256377a8dbff4f8efe001fbc206aa76b198d5b5a Mon Sep 17 00:00:00 2001 From: Haoxi Tan Date: Tue, 14 Jan 2020 15:01:34 +1000 Subject: [PATCH 3/6] updated PR template --- .github/PULL_REQUEST_TEMPLATE.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5f854b370..7891e87aa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,12 +6,6 @@ Thanks for submitting a PR! Please fill in this template where appropriate: This module is added to ... -## Changes made and file paths - -Added module example_module to modules/misc/example_module.. - -## Improvements made - ## Relevant links e.g. link to wiki page \ No newline at end of file From c01c07ad81af1a84741a47f9fcc279334e6af56e Mon Sep 17 00:00:00 2001 From: Haoxi Tan Date: Tue, 14 Jan 2020 15:02:44 +1000 Subject: [PATCH 4/6] updated PR template --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7891e87aa..ead343e92 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,8 @@ Thanks for submitting a PR! Please fill in this template where appropriate: -## Category: (Bug | module | extension | core functionality | documentation) +## Category + +(Bug / module / extension / core functionality / documentation) ## Feature/Issue Description From ee1739b200cea7d21e8451aa12c7ce8e917e6641 Mon Sep 17 00:00:00 2001 From: Haoxi Tan Date: Tue, 14 Jan 2020 15:12:56 +1000 Subject: [PATCH 5/6] updated PR template --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ead343e92..432117d09 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,12 +2,16 @@ Thanks for submitting a PR! Please fill in this template where appropriate: ## Category -(Bug / module / extension / core functionality / documentation) +(Bug / module / extension / core functionality / documentation / tests) ## Feature/Issue Description This module is added to ... +## Test cases + +spec/beef/extensions/example_extension.rb + ## Relevant links e.g. link to wiki page \ No newline at end of file From 3770b435344823b6187e081c9c085fbdb4818e0c Mon Sep 17 00:00:00 2001 From: Haoxi Tan Date: Tue, 14 Jan 2020 15:13:53 +1000 Subject: [PATCH 6/6] updated PR template --- .github/PULL_REQUEST_TEMPLATE.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 432117d09..2d956bba2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,6 +12,5 @@ This module is added to ... spec/beef/extensions/example_extension.rb -## Relevant links +## Relevant wiki page -e.g. link to wiki page \ No newline at end of file