Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History

Authoring a proposal


How do I create my proposal?

From the proposal homepage you will find a link to create a new proposal under the section "Submitting a New Proposal". This will ask you for the name of the proposal. Enter its name followed by your own—for example, "Zend_Magic - Harry Houdini". A proposal template will be generated, and your proposal will now be ready for editing. Instructions for the basic steps that need to be performed will be at the top of the page.

Ignore preview pane errors!
When creating a new proposal and editing the wiki markup for it, you will likely click on the preview pane at some point. Currently, the preview pane for this plugin generates several errors. Do not be alarmed by them; your page should save correctly provided that the wiki markup is valid. In any case, you can always edit the page again after saving, so please do not postpone saving your new proposal because of errors on the preview pane. We will correct this issue as soon as we can. Thanks!

The page created for my proposal contains all of these special zone-data tags. What's that about?

These tags wrap the content for your proposal, and allow us to apply a template in real time so that we can change the formatting, add new fields, and keep uniformity between the proposals. By looking at the sample data and by looking at the page in view mode, you can infer the meaning of each. When you enter edit mode, just replace the sample content with your own.

If you make a mistake, or accidentally remove any tags, just look at the source of another proposal to find what you are looking for.

Why does my new proposal say "Zend_Magic Proposal"?

The default page created for you contains sample content that you should change. Otherwise you may be forced to write the Zend_Magic component, which is one of the tougher ones to do.

How do I do this wiki formatting thing?

First, you can use the WYSIWYG editor, although for proposals it is better to modify wiki markup by hand. The WYSIWYG editor is never as good as hand-markup if you are a heavy user of macros, or cool things like templates. Thankfully, on the right-hand side of the editor is a quick help guide that is visible at all times. You can click that link for the full guide (at the top of the Help Tips) to see all markup options. It's based on Textile and pretty easy to learn, and generally good to know when working on the wiki.

When I put PHP code in my page, why do I get errors?

You need to wrap the code with {code} tags before and after the code sample. Otherwise, the open and close curly braces will appear to be wiki tags.

What should I concentrate on for my proposal?

In the early stages, concentrate on use cases, goals, and the purpose of the proposal so that the design can be measured against these requirements. Later, flesh out the API and class relationships, along with the theory of operation (how you perceive it will work). Once those elements are fairly stable, start to concentrate on the code.

When will my proposal move to the Laboratory?

If your proposal shows promise but doesn't directly contribute to the current roadmap, it may be accepted into the Laboratory for continued development as a component. In this case, your project will receive space in the Subversion repository and an issue tracker assigned to it. Successful Laboratory projects are candidates for future inclusion within the framework core.

When will my proposal move to the Incubator?

Accepted core proposals are moved to the Incubator and become part of the main release track. If your project was previously a part of the Laboratory, its issue tracker and repository will move into the main project at this time. For proposals moving directly into the Incubator, repository space will be created.

Laboratory projects without basic DocBook documentation and unit testing are unlikely to move into the Incubator. Also, please following the [Zend Framework coding standards], as that can also be a blocking point.

Do I need to include requirements, acceptance criteria, milestones, and so on?

Yes. Often the details and number needed are quite small, but without knowing the requirements and milestones, how will the community know the status of the component, when it will be "done", and what should be expected when it is?

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.