Skip to content
This repository was archived by the owner on Oct 22, 2020. It is now read-only.

Commit cafc77c

Browse files
committed
Add CONTRIBUTING.md
1 parent 9361ef7 commit cafc77c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# How to contribute
2+
Contributions are always welcome, however, to keep things consistent, please review the following guidelines.
3+
4+
## Update unit tests
5+
If you change a core piece of functionality (i.e. in ```lib/wpxf/*```) then ensure the corresponding unit tests in the ```spec``` folder are updated.
6+
7+
For more information on writing unit tests with RSpec, see https://relishapp.com/rspec
8+
9+
## Ensure RuboCop approves
10+
Unless there's good reason, there should be no [RuboCop](https://github.com/bbatsov/rubocop) warnings for any code you submit a pull request for. There have been changes to the [RuboCop](https://github.com/bbatsov/rubocop) configuration for this project to disable some rules and to increase the boundaries of some (such as line lengths), so when testing your files, ensure you're doing so using the ```.rubocop.yml``` found in the root directory.
11+
12+
## Provide instructions for testing new exploits and auxiliary modules
13+
If you're sending a pull request for a new auxiliary or exploit module, provide some basic information on how to test it. This should include:
14+
15+
- If the module targets a plugin or theme, provide a link to the vulnerable plugin / theme
16+
- If the module targets a specific version of WordPress, be clear which version or range it targets
17+
- Provide links to reference material if available (e.g. WPVulnDB link)
18+
19+
## Target the development branch
20+
When opening a pull request, compare with the ```development``` branch, rather than ```master```. The master branch is aimed at being equal to the latest stable release; meaning all staged changes need to go into the ```development``` branch.

0 commit comments

Comments
 (0)