[Community-allwww-cvs] www/2005/patch docsubmission.html,1.2,1.3
rishimathew at helixcommunity.org rishimathew at helixcommunity.orgUpdate of /cvsroot/common/www/2005/patch In directory cvs:/tmp/cvs-serv23217 Modified Files: docsubmission.html Log Message: 1. Improve general readability of the document(David Hirayama) Added summary-line to the document to make it easily parse-able by the reader. 2. Add another 3-char doc-type code for TestPlan Documents(Donya Shirzad) Added "TPD"- Test Plan Document to the list of 3-char document-type code. 3. Add clarification to make sure that Helix Contributor Agreement is signed by authorized representative.(Mike Frazier) 4. Change 3-char "SDS" to "SOD" (Milko Boic) Index: docsubmission.html =================================================================== RCS file: /cvsroot/common/www/2005/patch/docsubmission.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- docsubmission.html 12 Jul 2005 15:34:58 -0000 1.2 +++ docsubmission.html 16 Jul 2005 19:24:37 -0000 1.3 @@ -19,114 +19,112 @@ <p style="margin-top: 0.19in; margin-bottom: 0.19in;">The Helix community is keenly interested in reviewing changes you believe should be made to the Helix DNA code base -- those that fit the -technical direction of the DNA and are of sufficient quality will get +technical direction of the DNA will get incorporated. Before adding a new feature which requires significant architectural changes, it is optimal to document the feature in a Functional Specification and/or Statement of Design so that it can be reviewed by project leads who own the architecture of the Helix DNA.<br> </p> <p style="margin-top: 0.19in; margin-bottom: 0.19in;">All document -submittals must go through a design review process (DR). This process -in most cases will involve development on HEAD(main branch). Stable +submissions must undergo a Design Review process (DR). This process +in most cases will involve development on HEAD(main CVS branch). Stable branches are usually locked and in most cases do not accept new -features. <b></b>There are just a few steps to follow:</p> -<ol> - <li> - <p style="margin-bottom: 0in;">Before beginning the document -submittal -process please make sure that you are aware of and familiar with the +features. There are just a few steps to follow: <big><br> +</big></p> +<p style="margin-top: 0.19in; margin-bottom: 0.19in;"><big>1. Get +familiar with the Helix DNA Architecture</big><><br> +</></p> +<p style="margin-top: 0.19in; margin-bottom: 0.19in;"><>Before +beginning the document submission +process, please make sure that you are aware of and familiar with the existing Helix architecture. The inclusion of a new feature should not affect existing behavior in the best case, however, if it does affect -existing behavior then a detailed list of pros and cons should be +existing behavior, then a detailed list of pros and cons should be included in the document so that project leads are well aware of the -benefits and risks.<br> - </p> - </li> - <li> - <p style="margin-bottom: 0in;">To extend the Helix DNA, it is +benefits and risks.</><br> +</p> +<p style="margin-top: 0.19in; margin-bottom: 0.19in;"><big>2. Sign the +Contributor Agreement</big><br> +<br> +To extend the Helix DNA, it is necessary for you to sign the <a href="https://helixcommunity.org/2002/intro/contributor-agreement.pdf">HelixCommunity -Contributor Agreement</a>. Once you sign this agreement, you will be +Contributor Agreement</a>. Please be aware that this is a legally +binding agreement and must be signed by an authorized representative of +your organization. Once this agreement is signed, you will be given write-access to the CVS repository where design documents need to be checked in. <br> - </p> - </li> - <li> - <p style="margin-bottom: 0in;">A <a +</p> +<p style="margin-top: 0.19in; margin-bottom: 0.19in;"><big>3. Use the +provided Template </big><br> +</p> +<p style="margin-top: 0.19in; margin-bottom: 0.19in;">A <a href="https://common.helixcommunity.org/2005/patch/SoftwareDesignSpecificationTemplate">Design Document Template</a> has been made available so that all necessary -information can be provided by you. This template is in the preferred -HTML form. <br> - </p> - </li> - <li> - <p style="margin-bottom: 0in;">Each document should be identified -by a code for ease of tracking. Document code is structured as follows: - </p> - <pre class="code"> FFF-TTT-NNN-V.V <br> <br> FFF = Feature or Module identifier <br> <br> TTT = 3 character document type code: <br> SOD = Statement of Design Document <br> FRD = Functional Requirements Document <br> MRD = Marketing Requirements Document <br> USR = User Guide Document <br> <br> NNN = Document number within feature/module document set <br> <br> V.V = Document version number in form of <MajorVersionNumber>.<MinorVersionNumber> <br></pre> - <pre class="code"> Example: SVC-SDS-001-1.2 <br></pre> - <pre class="code"> FFF-TTT-[NNN-]<Human readable document title/description>.ext <br> <br> The document number (NNN-) can be omitted from the file name in case where only <br> one document exists for the feature or in case where the file name is for the <br> main document of the feature. <br></pre> - <pre class="code"> Example: SVC-SDS-001-StillVideoImageCapture.html <br> SVC-SDS-002-StillVideoImageCapture.html <br> <br> ZOM-SDS-VideoZoom.html </pre> - </li> - <li> - <p style="margin-bottom: 0in;">Next step is to find the right -project for your submission. The projects(which contain source -code) -line up one-to-one -with the top-level directory in your CVS working copy. So, -if you want to make a change to a feature or introduce a new feature -underneath /common, you need to commit your document in the "common" -project. However, there are certain features which cut across -individual projects. In this case, the right project to use is -helix-client / helix-server / helix-producer / player. These projects -are designed to be uber-projects which correspond to the main products -of the Helix DNA Platform.</p> - </li> - <li> - <p style="margin-bottom: 0in;">The precise location to commit -public documentation for Helix in published format is as follows: </p> - </li> - <ul> - <li> Location: +information about the new feature can be provided. This template is in +the preferred +HTML format. <br> +</p> +<big>4. Name the Document</big><br> +<br> +Each document should be identified +by a code for ease of tracking. Document code is structured as follows:<br> +<pre class="code"> FFF-TTT-NNN-V.V <br> <br> FFF = Feature or Module identifier <br> <br> TTT = 3 character document type code: <br> SOD = Statement of Design Document <br> FRD = Functional Requirements Document <br> MRD = Marketing Requirements Document <br> USR = User Guide Document <br> TPD - Test Plan Document<br> <br> NNN = Document number within feature/module document set <br> <br> V.V = Document version number in form of <MajorVersionNumber>.<MinorVersionNumber> <br></pre> +<pre class="code"> Example: SVC-SOD-001-1.2 <br></pre> +<pre class="code"> FFF-TTT-[NNN-]<Human readable document title/description>.ext <br> <br> The document number (NNN-) can be omitted from the file name in case where only <br> one document exists for the feature or in case where the file name is for the <br> main document of the feature. <br></pre> +<pre class="code"> Example: SVC-SOD-001-StillVideoImageCapture.html <br> SVC-SOD-002-StillVideoImageCapture.html <br> <br> ZOM-SOD-VideoZoom.html <br></pre> +<big>5. Find the right project and location for your document</big><br> +<br> +The next step is to find the right +project for your submission. Features generally pertain to one of +the following projects that correspond to the main products +of the Helix DNA Platform: +<ul> + <li>Helix Player</li> + <li>Helix DNA Client</li> + <li>Helix DNA Server</li> + <li>Helix DNA Producer</li> +</ul> +The precise location to commit +public documentation for Helix in published format is as follows: +<ul> + <li> Location: cvs.helixcommunity.org:/cvsroot/<project>/www/<year>/devdocs/<span style="font-style: italic;">filename</span>.html </li> - <li> Example: -cvs.helixcommunity.org:/cvsroot/client/www/2004/devdocs/<span + <li> Example: +cvs.helixcommunity.org:/cvsroot/helix-client/www/2005/devdocs/<span style="font-style: italic;">filename</span>.html</li> - <li>Use "cvs -d:ext:<span style="font-style: italic;">username</span>@cvs.helixcommunity.org:/cvsroot/<project> -co www" to checkout the tree. <br> - </li> - <li>Then add the document in the right location by using "cvs add + <li>Use "cvs -d:ext:<span style="font-style: italic;">username</span>@cvs.helixcommunity.org:/cvsroot/<project> +co www" to checkout the tree. </li> + <li>Then add the document in the right location by using "cvs add filename" and commit by using "cvs commit"</li> - <li>This document can then be accessed by your favorite HTML -browser at https://client.helixcommunity.org/2004/devdocs/<span - style="font-style: italic;">filename</span></li> - </ul> - <li> - <p style="margin-bottom: 0in;">Once your document has been -committed you should send an email notifying the project lead and the + <li>This document can then be accessed by your favorite HTML +browser at https://helix-client.helixcommunity.org/2005/devdocs/<span + style="font-style: italic;">filename</span> </li> +</ul> +<big>6. Send Notification about your submission</big><br> +<br> +Once your document has been checked into CVS you should send an email +notifying the project lead and the group of your submission. Complete the <a href="https://common.helixcommunity.org/2005/patch/design-form">Design Notification Form</a>. All document-review submissions should have a Subject line reading: "DR: -reason-or-project-or-descriptionâ€. For the “datatypeâ€, “commonâ€, -and -“filesystem†projects, or other projects used by both the Helix DNA -Client and the Helix DNA Server, patches should include “DR-Client†or -“DR-Server†as appropriate. To ensure that your documents are -accepted be +reason-or-project-or-descriptionâ€. To ensure that your documents +are +accepted, be sure you explicitly include one of the copyright statements in the form (the preferred method is to have signed and delivered a <a href="https://helixcommunity.org/2002/intro/contributor-agreement.pdf">Joint Copyright Assignment</a> to RealNetworks). Once all of the above requirements have been met, send the email to the appropriate project mailing -lists (If you have committed to client, send email to -client-dev at helixcommunity.org). <br> - </p> - </li> - <li> - <p style="margin-bottom: 0in;">Watch your inbox for discussion +lists (If you have committed to helix-client, send email to +helix-client-dev at helixcommunity.org). <br> +<br> +<big>7. Wait for Feedback on your submission</big><br> +<br> +Watch your inbox for discussion about your submission as developers inside and outside of Real will have a chance to review the changes for architectural flaws or defects. If the @@ -136,52 +134,40 @@ the opportunity to review it. Individual project owners can be found on the associated project home page. If no feedback is given in 24hrs, the -following will happen:</p> - <ol> - <li> - <p style="margin-bottom: 0in;">Submitter needs to re-send the +following should happen: +<ol> + <ul> + </ul> + <li> <>Submitter needs to re-send the DR request with the message titled “DR-Resend:†and mark the message as -high priority.</p> - </li> - <li> - <p style="margin-bottom: 0in;">The project owners of the area +high priority.</></li> + <li><>The project owners of the area DR’ed either will do the DR themselves or assign the DR to someone on the architecture team. All reviewers are required to respond within 24hrs. If the DR can’t be completed in 24hrs, the reviewer is required -to respond to the submitter with an estimated time.</p> - </li> - </ol> - </li> - <li> - <p style="margin-bottom: 0in;">After your documents have been +to respond to the submitter with an estimated time.</> </li> +</ol> +After your documents have been reviewed by the project owner you will receive feedback as -to whether the submittal is acceptable or changes need to be -made. Reviewers of your desgin will review these modifications +to whether the submission is acceptable or changes need to be +made. Reviewers of your design will review these modifications very closely and determine what if any risks are associated with your -submittal. Reviewers will be considering:</p> - <ol> - <li> - <p>Is the benefit of this submittal -greater than the risk? </p> - </li> - <li> - <p>If it does not support all +submission. Reviewers will be considering: <br> +<ul> + <li>Is the benefit of this submission +greater than the risk? </li> + <li>If it does not support all platforms, why? And is there a less platform-specific way to accomplish -the same thing?</p> - </li> - <li> - <p>Is there a simpler/safer way to -accomplish the same thing? </p> - </li> - <li> - <p>Does the change require an intellectual property review? </p> - </li> - </ol> - </li> - <li> - <p style="margin-bottom: 0in;">If no changes are necessary and your -submittal has been approved you will need to complete the <a +the same thing?</li> + <li><><>Is there a simpler/safer way to +accomplish the same thing?</></></li> + <li><><>Does the change require an Intellectual Property review? </></></li> +</ul> +<><><big>8. Commit your Document</big><br> +<br> +</></><></><>If no changes are necessary and your submission has been +approved you will need to complete the <a href="https://common.helixcommunity.org/2005/patch/design-form">Design Notification Form</a> and send it to the project mailing list, qa-contact (if any assigned) and the program @@ -189,17 +175,16 @@ DN-Client: <title> or DN-Server: <title>. Please note that approval from a branch owner AND a project owner is required when the two are not the same. Branch owners can be identified in the - <a href="https://helix-client.helixcommunity.org/2004/branches">Client -Branch Manifest</a>.</p> - </li> - <li> - <p style="margin-bottom: 0in;">Once you have completed this step, +<a href="https://helix-client.helixcommunity.org/2004/branches">Client +Branch Manifest</a>.<br> +<br> +<big>9. Begin Development of your Feature</big><br> +<br> +Once you have completed this step, you are officially cleared to begin development for your feature. Once -you have complete development, you can follow the <a +you have completed development, you can follow the <a href="https://common.helixcommunity.org/2005/patch/">Patch Submission Guidelines</a> to get your source-code checked into the Helix Community -CVS<>. </p> - </li> -</ol> +CVS. </> </body> </html>