Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 3.02 KB

How-to-help.md

File metadata and controls

23 lines (20 loc) · 3.02 KB
Raw

People Organization

We have two main groups of people helping this project move forward:

  1. Curators - These people run the project, put in countless hours organizing, approving, merging and adding content to the project. Their names can be found at the bottom of the https://github.com/pwnwiki/kaliwiki/blob/gh-pages/index.md page.
  2. Contributors - This group of people add content to the project. They are the heart and soul of this project and we thank them very much for their work! They can be found on the https://github.com/pwnwiki/kaliwiki/graphs/contributors page.

How to Contribute

  1. There are many tutorials on the Interwebz that describe how to work using git. Some of our favorites are below. Please check them out and, if you have never used git before, make a small, meaningful change to a file and submit the pull request. Our team of friendly curators will work with you to ensure you are following the Style Guide and have everything correct.
  2. The helpful tutorials for those new to git are:
    1. https://help.github.com/categories/54/articles
    2. http://ariejan.net/2011/11/09/contributing-to-open-source-with-github/
    3. http://blog.udacity.com/2013/10/get-started-with-open-source-projects_8.html
  3. You can go to the Issues Page to find out topics we'd like people to write up and add to the project or add your own!
  4. If you are looking for a place to start with a small change, start with filling out one of the sections of the tools located at https://github.com/pwnwiki/kaliwiki/tree/gh-pages/tools page. Links and Example Usage almost always could use more work.
  5. If you are still lost, please reach out to @eid010n, @webbreacher or another PwnWiki team member and they will walk you through what you need to do.

General Notes

  1. Please make pull requests of any changes. If you have commit rights to the PwnWiki content, please wait 24 hours before committing your own pull request, but feel free to have another committer review and merge your request sooner.
  2. After your pull request, someone will review your changes for quality assurance, and may provide comments on suggested changs prior to the merge.
  3. When you do push to master, sync gh-pages using the setup detailed here: http://brettterpstra.com/2012/09/26/github-tip-easily-sync-your-master-to-github-pages/
  4. The PwnWiki content is broken down into two main sections:
    1. Menus - Each menu mirrors the menu provided with the Kali distribution. The master menu can be found at https://github.com/pwnwiki/kaliwiki/blob/gh-pages/navigation.md, which links to all of the sub-menus.
    2. Tools - This is where we are storing all of the tool information files. The directory can be found here and the tool template can be found here