Merge branch 'master' of github.com:beefproject/beef
This commit is contained in:
32
.github/CONTRIBUTING.md
vendored
Normal file
32
.github/CONTRIBUTING.md
vendored
Normal file
@@ -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)
|
||||||
|
|
||||||
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
Thanks for submitting a PR! Please fill in this template where appropriate:
|
||||||
|
|
||||||
|
## Category
|
||||||
|
|
||||||
|
(Bug / module / extension / core functionality / documentation / tests)
|
||||||
|
|
||||||
|
## Feature/Issue Description
|
||||||
|
|
||||||
|
This module is added to ...
|
||||||
|
|
||||||
|
## Test cases
|
||||||
|
|
||||||
|
spec/beef/extensions/example_extension.rb
|
||||||
|
|
||||||
|
## Relevant wiki page
|
||||||
|
|
||||||
9
.github/SECURITY.md
vendored
Normal file
9
.github/SECURITY.md
vendored
Normal file
@@ -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
|
||||||
Reference in New Issue
Block a user