compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (37)

View Page History
{note:title=Ignore Errors on Preview Pane}
When creating a new proposal and you are editing the Wiki markup for it, you may click on the Preview pane to see what it looks like before you Save. Currently, the Preview pane for this plugin generates several errors that we are working to correct. Do not be alarmed by the errors; your page should Save correctly provided that the Wiki markup is valid. In any case, you can always edit the page, so please do not postpone saving your new proposal because of errors on the Preview pane, and we will strive to fix the problem as soon as reasonably possible. Thank you for your continued patience!
h1. Authoring a proposal

{note:title=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!
{note}

(i) *NOTE:* this page is editable by everyone, so if it isn't clear, update it!
{tip}
This page is editable by everyone. If the content isn't clear, please update it!
{tip}

h1. Knowing What to Expect When Authoring a Proposal (AKA Proposal FAQ)

{toc:type=list|indent=20px|minLevel=3|printable=true}

\\
h3. How do I submit create my proposal?

From the [proposal homepage|Home] you will find a link to create a new proposal under the section "Submitting a New Proposal". This will ask you for the name, usually something like "Zend_Magic Proposal" and then create a proposal from a template, and fill it with sample data. This page is now saved and ready for editing. Instructions for the basic steps that need performed will be at the top of the page.
From the [proposal homepage|Home] 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.

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

These tags wrap the content for your proposal. 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 contents with your own to fill out the proposal. What you are doing is really just setting the value of variables that a template will render against to create your page when viewed.
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.

These tags allow us to apply a template in real time to the proposals so that we can change the formatting, add new fields, and keep uniformity between the proposals.

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.

h3. Why does my new proposal say Zend_Magic Proposal or Zend_Something_Or_Other? "Zend_Magic Proposal"?

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

h3. How do I do this Wwiki formatting thing?

One, 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 the link for the full guide (at the top of the Help Tips) to see all markup options. It is quick to learn, based on Textile, and a good thing to know when working in our wiki a lot.
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.

h3. If I put PHP code into my page, sometimes I get errors!
h3. 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.

h3. 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 in how you perceive it working.
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.

Once you are fairly stable with those elements, then start to worry about code.
h3. When will my proposal move to the Laboratory?

h3. When will my proposal get space in 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 proposals are moved into "under review" they will have a issue tracker setup for them, as well as possibly a Laboratory SVN project created if coding needs to be done to prove out the proposal.
h3. When will my proposal move to the Incubator?

Proposals that are not accepted into Incubator right off, may want a Laboratory SVN project to support ongoing development so that they can continue to work on the component. The issue tracker will work hand-in hand with that as well.
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.

h3. When will my proposal move to "Incubator?"
Laboratory projects without basic DocBook documentation and unit testing are unlikely to move into the Incubator. Also, please following the [Zend Framework coding standards|ZFDEV:PHP Coding Standard (draft, ZF 0.2 RC1)], as that can also be a blocking point.

Accepted proposals will move to Incubator meaning that they are part of the main release track. Their issue tracker will merge into the main framework project and become a component of that project rather than a stand-alone project. Their SVN repository (if they have one in Laboratory) will move into a subdirectory within the main project.
h3. Do I need to include requirements, acceptance criteria, milestones, and so on?

Projects are unlikely to move to Incubator that do not have basic DocBook documentation and are showing signs of having decent test coverage. Also please following the [Zend Framework coding standards|ZFDEV:PHP Coding Standard (draft, ZF 0.2 RC1)] as that will be a blocking point as well.

h3. Do I need to include requirements, acceptance criteria, and milestones/tasks ?

Yes. Often the details and number needed are quite small, but without knowing the requirements (what exactly should the component do), and milestones, how will the community know the status of the component, when it will be "done", or what to expect when it is "done"?
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?