Difference between revisions of "How To Submit A Viewer Change"

Latest revision as of 14:16, 6 July 2017

This is not the place to start if you want to change the Viewer.
If you are interested in proposing a Viewer feature or modification, see How To Propose A Viewer Feature.

This page is one part of the Viewer Integration and Release Processes and, before you belong here, you should already have gotten your proposed change accepted (strictly speaking, if you want to do the work of implementing the change first, that's up to you, but you still have to go back and get the idea accepted before you submit the code).

For general advice on how to prepare changes so that they can get through the review and submission process easily, see Submitting code.

Submitting an Integration Request

Commit access to the viewer-development repository is managed by the Snowstorm team.

A full description of the Snowstorm workflow is below. The criteria to be met before submitting an integration request, and complete instructions for completing a merge request, are described in the following sections.

Readiness Criteria

Changes must meet all of the Development Integration Criteria before it can be pulled to the Development repository.

Functionality must have been reviewed and accepted by the Product Owner:
Normally, this means that the item must be on the current Sprint Backlog for the Snowstorm Project Team or some other Linden viewer development team, and has been reviewed by the Product Manager for that team. See How To Propose A Viewer Feature.
Design and code must have been reviewed by competent reviewers.
Reviewer(s) must be identified in the Jira item(s) used to track the change.

The strongly preferred way to review code is to create a fork of the viewer-release repository and commit the changes to that fork, then fill in the URL for that fork in the "Repository Fixed In" field of a Jira issue.
There must be a test plan
The test plan must describe in detail how Integration QA can validate the modified behavior.
- For bug fixes, putting the test plan into a Jira comment is acceptable (since the issue should already contain a documented way to reproduce the problem, this should not be much new work).
- For features, links to wiki pages are preferred.
- For features especially, building and distributing a viewer from the Project repository for live testing is strongly encouraged.
The Project repository must have merged in the latest changes from viewer-release.
The results must be validated by building viewers for all platforms and doing at least minimal viewer testing.
There must be a Contribution Agreement on file from each contributor to the change that is not a Linden employee or contractor.
- External contributions must include the appropriate updates to doc/contributions.txt
- If you already have one or more entries in contributions.txt, add new ones at the appropriate positions (sorting yours, if desired).

Linden Submissions

After the code has met all of the above-stated Readiness Criteria, submit a Merge Request as detailed on the (internal) Viewer Release Workflow page.

Open Source Submissions

Open source contributors should be working on issues that are already in the Snowstorm Jira project. Before submitting (or even doing work) it is best to have first made a proposal and had it approved as described on the Snowstorm Project page (any submission will go through this review anyway, and not doing it at the outset may mean doing work that either isn't accepted at all or will have to be significantly modified).

The following describes the workflow for issues in the Snowstorm Jira project. Issues enter this workflow either by being moved from the BUG project, or when a proposal outside jira is accepted and a STORM issue created directly. The same workflow is used for the Open Development Jira project, but issues there are only for changes to the process of building the viewer, not for changes to how the viewer works.

Open this link in a new window to see the workflow diagram.

Note: You can see the workflow, with the current step for an issue highlighted, by clicking on the '(View Workflow)' link next to its Status in the issue display.

Open: An issue that is ready to be worked on; it may or may not be Assigned to someone. When someone takes responsibility for it, the issue should be Assigned to them and they should execute the Start Progress transition to move the issue to show that work has begun (as a side effect, this Assigns the issue to that user).

→ Start Progress →

In Progress

When a developer has finished work, they:

set the Branch/Repo Fixed In and Changeset/Revision ID fields to point to a public mercurial repository containing the change
set the Code Review field to the URL of the Diff display in the Bitbucket "Compare" display.
execute the transition to indicate that it is ready:

→ Ready For Review (assignee only) →

Code Review: Reviews may come from other open source developers and/or Lindens. The developer should respond to issues raised in the review; when the code passes code review, Oz will send it to the QA team (sometimes bundled with other issues in a test build) and transition the issue

→ Pass Code Review →

Team QA: Linden internal QA team will test the issue using the test plan in the issue and the existing regression tests, and if it passes,

→ Pass Team QA →

Product Review: This is the final acceptance review by the Linden Product Team; when it has been approved for integration

→ Approved →

Integration Ready: which indicates that it is eligible to be merged to viewer-development; when that has happened

→ Integrated →

Integrated: where it will again be tested for problems that may have arisen due interactions with other new development

→ Pass IQA →

Passed IQA: where it will remain until the next release is created from viewer-development; the final transition

→ Close →

Closed: because it's in the Viewer!

of course, each of these steps also include the possibility of some failure, which will transition the issue back to Open for further work, and then the cycle begins again.

Tracking

You can see the current state of the Snowstorm issues on the shared "Snowstorm" dashboard in Jira.

@@ Line 1: / Line 1: @@
 {{Project Snowstorm Nav}}
+'''This is not the place to start''' if you want to change the Viewer.<br />
-'''This is not the place to start''' if you want to change the Viewer; this is one part of the [[Viewer Integration and Release Processes]], and before you belong here, you must have gotten your proposed change accepted (strictly speaking, if you want to do the work of implementing the change first, that's up to you, but you still have to go back and get the idea accepted before you submit the code).   See [[How To Propose A Viewer Feature]].
+If you are interested in proposing a Viewer feature or modification, see [[How To Propose A Viewer Feature]].
+<br /><br />
+__TOC__
+<br clear="all"/>
+This page is one part of the [[Viewer Integration and Release Processes]] and, before you belong here, you should already have gotten your proposed change accepted (strictly speaking, if you want to do the work of implementing the change first, that's up to you, but you still have to go back and get the idea accepted before you submit the code).
+<br /><br />
 For general advice on how to prepare changes so that they can get through the review and submission process easily, see [[Submitting code]].
-__TOC__
-<br clear="all"/>
 ==Submitting an Integration Request==
+<br />
+Commit access to the viewer-development repository is managed by the Snowstorm team.<br /><br />
-Commit access to the viewer-development repository is managed by the Snowstorm team.
+A full description of the [[#Snowstorm Workflow Detail|Snowstorm workflow is below]].  The criteria to be met before submitting an integration request, and complete instructions for completing a merge request, are described in the following sections.
+<br /><br />
-A full description of the [[#Snowstorm Workflow Detail|Snowstorm workflow is below]].  The checks that must be done before submitting to the integration repository and the mechanics of creating that integration request follow:
+----
 ===Readiness Criteria===
+<br />
 Changes must meet all of the [[Viewer Integration and Release Processes#Development_Integration_Criteria|Development Integration Criteria]] before it can be pulled to the Development repository.
@@ Line 22: / Line 27: @@
 # '''Design and code must have been reviewed by competent reviewers.'''
 #: Reviewer(s) must be identified in the Jira item(s) used to track the change.
-#: The strongly preferred way to review code is to post the change on the [[Code Review Tool]] site.
+#: The strongly preferred way to review code is to create a fork of the [https://bitbucket.org/lindenlab/viewer-release viewer-release] repository and commit the changes to that fork, then fill in the URL for that fork in the &quot;Repository Fixed In&quot; field of a Jira issue.
 # '''There must be a test plan'''
 #: The test plan must describe in detail how Integration QA can validate the modified behavior.
@@ Line 28: / Line 33: @@
 #:* For features, links to wiki pages are preferred.
 #:* For features especially, building and distributing a viewer from the Project repository for live testing is strongly encouraged.
-# '''The Project repository must have merged in the latest changes from Development.'''
+# '''The Project repository must have merged in the latest changes from viewer-release.'''
 #: The results must be validated by building viewers for all platforms and doing at least minimal viewer testing.
-# '''There must be a [http://secondlifegrid.net.s3.amazonaws.com/docs/SLVcontribution_agmt.pdf Contribution Agreement] on file from each contributor to the change that is not a Linden employee or contractor.'''
+# '''There must be a [http://lecs-opensource.secondlife.com/SLVcontribution_agmt.pdf Contribution Agreement] on file from each contributor to the change that is not a Linden employee or contractor.'''
-#* External contributions '''must''' include the appropriate updates to doc/contributions.txt
+#* External contributions '''must''' include the appropriate updates to <code>doc/contributions.txt</code>
-#* If you already have one or more entries in contributions.txt add new ones below the older ones; do not sort your list numerically. Changes to this file are used internally to see what has been done since the last release and to generate statistics.  #*If you generate a diff your change should show only lines being added, never deleted or moved.
+#* If you already have one or more entries in <code>contributions.txt</code>, add new ones at the appropriate positions (sorting yours, if desired).
+<br />
+----
 ===Linden Submissions===
+<br />
-Requests coming from Linden Lab developers not on the Snowstorm team will typically be working on issues in Jira projects other than Snowstorm.  Linden developers may request write access to the Development branch:  send email to Oz and/or Q with the name of your account at bitbucket.org.
+''After'' the code has met all of the above-stated Readiness Criteria, submit a Merge Request as detailed on the (internal) [https://wiki.lindenlab.com/wiki/Viewer_Release_Workflow#Submitting_a_Merge_Request Viewer Release Workflow page].
-Alternatively, when the code is ready to be integrated you can request that the Snowstorm team pull your change by [https://jira.secondlife.com/secure/CreateIssue.jspa?pid=10244&issuetype=20 creating a '''Merge Request''' Issue in the Snowstorm Jira project].  It must contain a URL for the repository and changeset to be pulled.  You should ''Link'' this merge request issue to the issue or issues in your own project.  One of the Snowstorm team members will pick up the issue and do the pull.
-Note that by default all issues in Snowstorm are publicly visible.
 ===Open Source Submissions===
-Open source contributors should be working on issues that are already in the Snowstorm project and on the Sprint Backlog, so the issues involved should already be in the Snowstorm project.  For these issues, execute the '''Ready For Review''' transition (you must be in the ''In Progress'' state for this transition to be available).
+Open source contributors should be working on issues that are already in the [http://jira.secondlife.com/browse/STORM Snowstorm Jira project].  Before submitting (or even doing work) it is best to have first made a proposal and had it approved as described on the [[Snowstorm Project]] page (any submission will go through this review anyway, and not doing it at the outset may mean doing work that either isn't accepted at all or will have to be significantly modified).
-== Snowstorm Workflow Detail ==
+The following describes the workflow for issues in the [http://jira.secondlife.com/browse/STORM Snowstorm Jira project].  Issues enter this workflow either by being moved from the BUG project, or when a proposal outside jira is accepted and a STORM issue created directly. The same workflow is used for the [http://jira.secondlife.com/browse/OPEN Open Development Jira project], but issues there are ''only'' for changes to the process of building the viewer, not for changes to how the viewer works.
-The sections below describe the workflow for issues in the [http://jira.secondlife.com/browse/STORM Snowstorm Jira project].  Issues enter this workflow either by being moved from the VWR project, or when a '''Merge Request''' issue is created by some Linden scrum team that is ready to merge into the main development viewer.
+[https://jira.secondlife.com/plugins/servlet/workflow/thumbnail/getThumbnail?workflowName=Team%20Development%20Workflow&stepId=10&width=full&height=full| Open this link in a new window to see the workflow diagram].
-[[Image:JIRA-STORM-workflow.png|right]]
+{{KBnote|You can see the workflow, with the current step for an issue highlighted, by clicking on the '(View Workflow)' link next to its Status in the issue display.}}
-===Normal Workflow Transitions===
+;Open
+:An issue that is ready to be worked on; it may or may not be Assigned to someone.  When someone takes responsibility for it, the issue should be Assigned to them and they should execute the ''Start Progress'' transition to move the issue to show that work has begun (as a side effect, this Assigns the issue to that user).
+&rarr; ''Start Progress'' &rarr;
+;In Progress
+:When a developer has finished work, they:
+:*set the '''Branch/Repo Fixed In''' and '''Changeset/Revision ID''' fields to point to a public mercurial repository containing the change
+:*set the '''Code Review''' field to the URL of the Diff display in the Bitbucket &quot;Compare&quot; display.
+:*execute the transition to indicate that it is ready:
+&rarr; ''Ready For Review'' (''assignee only'') &rarr;
+;Code Review
+:Reviews may come from other open source developers and/or Lindens.  The developer should respond to issues raised in the review; when the code passes code review, Oz will send it to the QA team (sometimes bundled with other issues in a test build) and transition the issue
+&rarr; ''Pass Code Review'' &rarr;
+;Team QA
+:Linden internal QA team will test the issue using the test plan in the issue and the existing regression tests, and if it passes,
+&rarr; ''Pass Team QA'' &rarr;
+;Product Review
+:This is the final acceptance review by the Linden Product Team; when it has been approved for integration
+&rarr; ''Approved'' &rarr;
+;Integration Ready
+:which indicates that it is eligible to be merged to viewer-development; when that has happened
+&rarr; ''Integrated'' &rarr;
+;Integrated
+:where it will again be tested for problems that may have arisen due interactions with other new development
+&rarr; ''Pass IQA'' &rarr;
+;Passed IQA
+:where it will remain until the next release is created from viewer-development; the final transition
+&rarr; ''Close'' &rarr;
+;Closed
+:because it's in the Viewer!
-;Open&rarr;''Start Progress''&rarr;In Progress (''assignee only'')
+of course, each of these steps also include the possibility of some failure, which will transition the issue back to Open for further work, and then the cycle begins again.
-:When a developer picks a task to work on from the Sprint List, they Assign the task to themselves and execute this transition to show that work has begun.
-;In Progress&rarr;''Ready For Review''&rarr;Reviewing (''assignee only'')
-:When a developer has finished work, they execute this transition, setting:
-:*'''Branch/Repo Fixed In''' and '''Changeset/Revision ID''' fields to point to a public mercurial repository containing the change
-:*'''Code Review''' to the URL of [[Code Review Tool#Post Code To Be Reviewed|a code review in the Code Review Tool]]
-;Reviewing&rarr;''Add Approval''&rarr;Reviewing
-:When each review is complete, the reviewer (normally a Linden) executes this transition, checking either '''Product Owner''' or '''Code Review''' in the '''Approvals''' field.
-:When both are checked, the last reviewer should execute the ''Merge'' transition.
-;Reviewing&rarr;''Merge''&rarr;Approved
-:At this point, the issue should have satisfied all of the [[#Readiness Criteria|Readiness Criteria]].  This transition moves the issue to the Snowstorm Integration Queue (including setting it to Unassigned)
-;Approved&rarr;''Integrated''&rarr;Integration Test
-:When a Snowstorm Team member takes responsibility for pulling the request, they Assign it to themselves (thus removing it from the queue), and execute the hg steps to pull the change to viewer-development.  When that is complete, they execute this transition to indicate that QA should test it (sets Assignee to Unassigned).
-;Integration Test&rarr;''Pass QA''&rarr;Passed QA
-:When a QA tester has confirmed that the issue is fixed in a Development (or later stage - Beta or other release candidate) build, they execute the Passed QA transition.
-;Passed QA&rarr;''Close''&rarr;Closed
-:When Release posts the final stable release that includes the change for the issue, this transition is executed.
-<br style='clear: both;'/>
-===Exception Workflow Transitions===
-;Open&harr;''Needs More Info/Re-Open''&rarr;Needs More Info
-:If information from the Reporter or someone else is needed in order to complete the request, these transitions are used to reflect that.
-;Reviewing&rarr;''Reject''&rarr;Open
-:If either review determines that the change is not ready, this transition is used to return the issue to the developer.
-;Approved&rarr;''Integration Failed''&rarr;Open
-:If a problem arises when integrating a change, the person that finds the problem executes this transition to return the issue to the developer with a description of the problem to be solved.
-;Integration Test&rarr;''Fail QA''&rarr;Open
-:Used by QA to indicate that when tested in a Development (or later stage) build, the test failed
 ==Tracking==
-You can see the current state of the Snowstorm queues:
+You can see the current state of the Snowstorm issues on the shared [https://jira.secondlife.com/secure/Dashboard.jspa?selectPageId=13615 "Snowstorm" dashboard] in Jira.
-;[http://jira.secondlife.com/secure/IssueNavigator.jspa?mode=hide&requestId=13082 Reviewing]
-: Development is believed to be complete, and issue is awaiting review and approval.
-;[http://jira.secondlife.com/secure/IssueNavigator.jspa?mode=hide&requestId=13064 Integration]
-: Change has been approved for integration into viewer-development
-;[http://jira.secondlife.com/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+STORM+AND+status+%3D+Integrated+ORDER+BY+updated+DESC%2C+priority+DESC Testing]
-: Change has been integrated and is awaiting QA
-These and other Project Snowstorm tracking information are available on the shared "Snowstorm" dashboard in Jira.