Skip to content

CodeStructure

thc202 edited this page Jun 24, 2015 · 3 revisions

The code is structured in the repo as follows:

v1.4 Extensions

All extensions for ZAP 1.4 line in the 1.4 branch (removed, 1.4 extensions are no longer maintained).

v2.2 Extensions

2.2 Alpha Extensions

New extensions should typically be added to the alpha branch

Code in this branch must compile, but may not be complete or have a variety of issues.

When you are happy that your code is working correctly and follows most of the development rules and guidelines post a request to the ZAP developer group to ask for a review. If the general consensus is that it is ready then you can move it to the beta branch.

2.2 Beta Extensions

Code in the beta branch has been reviewed and can be expected to be generally fit for purpose.

When you are happy that your code is ready for release status and follows all of the development rules and guidelines post a request to the ZAP developer group to ask for another review. If the general consensus is that it is ready then you can move it to the trunk.

2.2 Release Extensions

Code in master has been reviewed and can be expected to be of high quality.

Notes

Version numbers should increase sequentially when changes are made or when the extension moves to a new branch or master.

You do not have to perform a release when you change the code - its up to the author to decide when their code is ready.

We would not normally expect an extension to drop, eg from release to beta, but that can happen if there are problems with it.

An extension should have only one release, and in any case the code will only show the most recent release.

In the 'check for updates' code the version number takes precedence - so an alpha-3 release is an update to a beta-2 release.

If you need to use features in your add-on that are only available in the trunk then people get in touch via the ZAP developer group.

Clone this wiki locally