Contributing 101

Introduction

Ready to contribute with the w3af project but don't know anything about git or development? This guide will help you contribute.

10 steps to contributing

1. Create a Github user
2. Fork the w3af repository by browsing to the w3af project at github and clicking on the "Fork" button that's on the top-right part of the page
3. Install git sudo apt-get install git
4. Install git flow sudo apt-get install git-flow
5. Download the source code from your fork, configure the git username and email, and start a new feature branch with git-flow. Make sure you replace <username> in the first command, <feature_name> in the last and enter the correct values for git config:

git clone --recursive [email protected]:<username>/w3af.git
cd w3af
git config user.name "Your Name Here"
git config user.email "[email protected]"
git branch master origin/master
git flow init -d
git flow feature start <feature_name>

6. Modify w3af's source code and test it
7. Use git status and git diff to review your changes
8. Use git commit path/to/changes/ to commit your changes, make sure you describe exactly what you've done
9. Push your changes to Github:

git flow feature finish <feature_name>
git flow feature publish <feature_name>

10. Replace <username> in this link and copy+paste it in your browser in order to create a "Pull Request" https://github.com/<username>/w3af/pull/new/master . Complete the required parameters in order for us to understand your changes.

Advanced contributors

Advanced contributors and w3af developers need to follow all the guidelines explained in the Developer's-Guide document.