|
|
| Line 72: |
Line 72: |
| | | | |
| | |} | | |} |
| − |
| |
| − | =FAQs=
| |
| − |
| |
| − | <!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
| |
| − | <span style="color:#ff0000">
| |
| − | Many projects have "Frequently Asked Questions" documents or pages. However, the point of such a document is not the questions. ''The point of a document like this are the '''answers'''''. The document contains the answers that people would otherwise find themselves giving over and over again. The idea is that rather than laboriously compose and post the same answers repeatedly, people can refer to this page with pre-prepared answers. Use this space to communicate your projects 'Frequent Answers.'
| |
| − | </span>
| |
| − |
| |
| − | ==How can I participate in your project?==
| |
| − | All you have to do is make the Project Leader's aware of your available time to contribute to the project. It is also important to let the Leader's know how you would like to contribute and pitch in to help the project meet it's goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key.
| |
| − |
| |
| − | ==If I am not a programmer can I participate in your project?==
| |
| − | Yes, you can certainly participate in the project if you are not a programmer or technical. The project needs different skills and expertise and different times during its development. Currently, we are looking for researchers, writers, graphic designers, and a project administrator. See the Road Map and Getting Involved tab for more details.
| |
| | | | |
| | = Acknowledgements = | | = Acknowledgements = |
| | ==Contributors== | | ==Contributors== |
| | | | |
| − | <!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
| + | The OWASP Juice Shop is developed by a worldwide team of volunteers. A live update of project [https://github.com/bkimminich/juice-shop/graphs/contributors contributors is found here]. |
| − | <span style="color:#ff0000">
| |
| − | The success of OWASP is due to a community of enthusiasts and contributors that work to make our projects great. This is also true for the success of your project.
| |
| − | Be sure to give credit where credit is due, no matter how small! This should be a brief list of the most amazing people involved in your project.
| |
| − | Be sure to provide a link to a complete list of all the amazing people in your project's community as well.
| |
| − | </span>
| |
| − | | |
| − | The OWASP Tool Project Template is developed by a worldwide team of volunteers. A live update of project [https://github.com/OWASP/Security-Principles/graphs/contributors contributors is found here]. | |
| | | | |
| | The first contributors to the project were: | | The first contributors to the project were: |
| | | | |
| − | * [https://www.owasp.org/index.php/User:Clerkendweller Colin Watson] who created the OWASP Cornucopia project that the template was derived from | + | * [[User:Bjoern Kimminich|Bjoern Kimminich]] |
| − | * [https://www.owasp.org/index.php/User:Chuck_Cooper Chuck Cooper] who edited the template to convert it from a documentation project to a Tool Project Template
| |
| − | * '''YOUR NAME BELONGS HERE AND YOU SHOULD REMOVE THE PRIOR 3 NAMES'''
| |
| | | | |
| | = Road Map and Getting Involved = | | = Road Map and Getting Involved = |
| − | Juice Shop is already implemented, properly tested and has been promoted (see https://github.com/bkimminich/juice-shop#blog-links) and showcased/hacked on various occasions including OWASP events (see https://github.com/bkimminich/juice-shop#conferences-and-meetups). It has been successfully used by different companies for inhouse security trainings.
| |
| − |
| |
| − | On the roadmap are further bugfixing (https://github.com/bkimminich/juice-shop/issues). stabilization of the underlying architecture (e.g. migrating to Angular2, modernizing the testing frameworks etc.) as well as continually adding more features/vulnerabilities to the application.
| |
| | | | |
| − | <!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
| + | Juice Shop is already implemented, properly tested and [https://github.com/bkimminich/juice-shop#blog-links has been promoted] and [https://github.com/bkimminich/juice-shop#conferences-and-meetups demonstrated or live-hacked on various occasions including OWASP events]. It has been successfully used by different companies for inhouse security trainings. |
| − | <span style="color:#ff0000">
| |
| − | A project roadmap is the envisioned plan for the project. The purpose of the roadmap is to help others understand where the project is going as well as areas that volunteers may contribute. It gives the community a chance to understand the context and the vision for the goal of the project. Additionally, if a project becomes inactive, or if the project is abandoned, a roadmap can help ensure a project can be adopted and continued under new leadership.
| |
| − | Roadmaps vary in detail from a broad outline to a fully detailed project charter. Generally speaking, projects with detailed roadmaps have tended to develop into successful projects. Some details that leaders may consider placing in the roadmap include: envisioned milestones, planned feature enhancements, essential conditions, project assumptions, development timelines, etc. You are required to have at least 4 milestones for every year the project is active.
| |
| − | </span>
| |
| | | | |
| | ==Roadmap== | | ==Roadmap== |
| − | As of <strong>November, 2013, the highest priorities for the next 6 months</strong> are:
| |
| − | <strong>
| |
| − | * Complete the first draft of the Tool Project Template
| |
| − | * Get other people to review the Tool Project Template and provide feedback
| |
| − | * Incorporate feedback into changes in the Tool Project Template
| |
| − | * Finalize the Tool Project template and have it reviewed to be promoted from an Incubator Project to a Lab Project
| |
| − | </strong>
| |
| | | | |
| − | Subsequent Releases will add
| + | * [https://github.com/bkimminich/juice-shop/issues further bugfixing] |
| − | <strong>
| + | * stabilization of the underlying architecture (e.g. migrating to Angular2, modernizing the testing frameworks etc. |
| − | * Internationalization Support | + | * continually adding more features/vulnerabilities to the application |
| − | * Additional Unit Tests | |
| − | * Automated Regression tests | |
| − | </strong>
| |
| | | | |
| | ==Getting Involved== | | ==Getting Involved== |
| − | Involvement in the development and promotion of <strong>Tool Project Template</strong> is actively encouraged!
| |
| − | You do not have to be a security expert or a programmer to contribute.
| |
| − | Some of the ways you can help are as follows:
| |
| − |
| |
| − | ===Coding===
| |
| − | We could implement some of the later items on the roadmap sooner if someone wanted to help out with unit or automated regression tests
| |
| − | ===Localization===
| |
| − | Are you fluent in another language? Can you help translate the text strings in the <strong>Tool Project Template</strong> into that language?
| |
| − | ===Testing===
| |
| − | Do you have a flair for finding bugs in software? We want to product a high quality product, so any help with Quality Assurance would be greatly appreciated. Let us know if you can offer your help.
| |
| − | ===Feedback===
| |
| − | Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template Tool Project Template project mailing list] for feedback about:
| |
| − | <ul>
| |
| − | <li>What do like?</li>
| |
| − | <li>What don't you like?</li>
| |
| − | <li>What features would you like to see prioritized on the roadmap?</li>
| |
| − | </ul>
| |
| − |
| |
| − | =Minimum Viable Product=
| |
| − | <!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
| |
| − | <span style="color:#ff0000">
| |
| − | This page is where you should indicate what is the minimum set of functionality that is required to make this a useful product that addresses your core security concern.
| |
| − | Defining this information helps the project leader to think about what is the critical functionality that a user needs for this project to be useful, thereby helping determine what the priorities should be on the roadmap. And it also helps reviewers who are evaluating the project to determine if the functionality sufficiently provides the critical functionality to determine if the project should be promoted to the next project category.
| |
| − | </span>
| |
| − |
| |
| − | The Tool Project Template must specify the minimum set of tabs a project should have, provide some an example layout on each tab, provide instructional text on how a project leader should modify the tab, and give some example text that illustrates how to create an actual project.
| |
| − |
| |
| − | It would also be ideal if the sample text was translated into different languages.
| |
| | | | |
| − | =Project About=
| + | Involvement in the development and promotion of <strong>Juice Shop</strong> is actively encouraged! |
| − | <!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
| + | You do not have to be a security expert or a programmer to contribute. Some of the ways you can help are as follows: |
| − | <span style="color:#ff0000"> | |
| − | This page is where you need to place your legacy project template page if your project was created before October 2013. To edit this page you will need to edit your project information template. You can typically find this page by following this address and substituting your project name where it says "OWASP_Example_Project". When in doubt, ask the OWASP Projects Manager.
| |
| − | Example template page: https://www.owasp.org/index.php/Projects/OWASP_Example_Project
| |
| − | </span>
| |
| | | | |
| − | {{:Projects/OWASP_Example_Project_About_Page}}
| + | * provide ideas for new challenges to be added |
| | + | * provide feedback via email, chat or by opening an issue on GitHub |
| | | | |
| | __NOTOC__ <headertabs /> | | __NOTOC__ <headertabs /> |
| | | | |
| | [[Category:OWASP Project]] [[Category:OWASP_Builders]] [[Category:OWASP_Defenders]] [[Category:OWASP_Tool]] | | [[Category:OWASP Project]] [[Category:OWASP_Builders]] [[Category:OWASP_Defenders]] [[Category:OWASP_Tool]] |
