Changes/Policy

From FedoraProject

< Changes(Difference between revisions)
Jump to: navigation, search
m (Jreznik moved page JaroslavReznik/ChangeProposalTemplate to Changes/Policy: Approved by FESCo)
(Now it's really Changes Policy, not template)
Line 1: Line 1:
{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "edit" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR CHANGE PROPOSAL.'''}}
+
{{admon/tip | Quick Links | If you know the process already, you can jump immediately to [[JaroslavReznik/ChangeProposalTemplate | an empty feature form]].}}
  
<!-- Self Contained or System Wide Change Proposal?
+
= Fedora Releases Planning Process =
Use this guide to determine to which category your proposed change belongs to.
+
  
Self Contained Changes are:
+
Motivation behind the planning process is to raise the visibility of planned changes, to make coordination and planning effort easier, as otherwise it is nearly impossible to follow all changes happening in such a big project as Fedora is. It has to be easy to submit the Change Proposal, as early as possible, before the change is implemented and even in very early state of idea, to gather community feedback and review.
* changes to isolated/leaf package without the impact on other packages/rest of the distribution
+
* limited scope changes without the impact on other packages/rest of the distribution
+
* coordinated effort within SIG with limited impact outside SIG functional area, accepted by the SIG
+
  
System Wide Changes are:
+
The list of accepted changes (Change Set) is used by different teams across the project, for example to prepare external facing materials like Release notes and Release announcements.  
* changes that does not fit Self Contained Changes category touching
+
* changes that require coordination within the distribution (for example mass rebuilds, release engineering or other teams effort etc.)
+
* changing system defaults
+
  
For Self Contained Changes, sections marked as "REQUIRED FOR SYSTEM WIDE CHANGES" are OPTIONAL but FESCo/Wrangler can request more details (especially in case the change proposal category is
+
Planning process is an internal planning and tracking tool and the final release does not have to reflect all proposed changes.
improper or updated to System Wide category). For System Wide Changes all fields on this form are required for FESCo acceptance (when applies).  
+
  
We request that you maintain the same order of sections so that all of the change proposal pages are uniform.
+
== Changes Categories ==
-->
+
Fedora Engineering and Steering Committee (FESCo) defined two Change categories:
 +
# Self Contained Changes
 +
# System Wide Changes
  
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name. This keeps all change proposals in the same namespace -->
+
== Self Contained Changes ==
 +
The self contained changes are changes to isolate package(s) or generally all changes with limited scope and impact on the rest of distribution/project. For example addition of a group of leaf packages or coordinated effort within SIG with limited impact outside SIG functional area. Self Contained Changes could be used for early idea state proposals for wider and complex changes.
  
= Change Proposal Name <!-- The name of your change proposal --> =
+
Public announcement of the new Self Contained Changes helps to co-operate on the change and extends proposed change visibility. Change owners may find help from the community or useful comments. These changes don't have to be thoroughly reviewed by FESCo. Based on the community review, Self Contained Change can be updated to the System Wide Change category and Owner can be asked to provide more details and extend Change Proposal Papge.
  
== Summary ==
+
{{Admon/note | This will be explained in more details in the link.}}
<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. -->
+
=== The process for Self Contained Features ===
 +
* Change Proposal is submitted according to the Change Proposal Submission policy
 +
* The formal correctness of Proposed Change page is checked by the Wrangler
 +
* Once the Change Proposal is correct, it's announced on Fedora Devel Announce list by the Wrangler.
 +
* No documentation process (optional), only release notes advertisement
 +
* Aggregated list of Change Proposals is added to FESCo agenda no sooner than a  week (or more) after the announcement on the mailing list.
 +
** In case of no complaints (possible breakage/conflicts, coordination needed) on Fedora Devel mailing list/or from FESCo members, FESCo approves those Change Proposals without more scope and etc. investigation. Every team on Fedora devel can share their views and escalate proposed change to FESCo to go through the regular System Wide Changes process. Change owner could be asked to provide more details/or move the change to the "complex changes" category. FESCo members are encouraged to ask questions on the mailing list instead of waiting for the meeting.
  
== Owner ==
+
== Complex System Wide Changes ==
<!--
+
Complex System Wide Changes are system-wide/defaults or critical path components changing changes which does not belong to Self Contained Changes.
For change proposals to quality as self-contained, owners of all affected packages need to be included here. Alternatively, a SIG can be listed as an owner if it owns all affected packages.
+
This should link to your home wiki page so we know who you are.
+
-->
+
* Name: [[User:FASAcountName| Your Name]]
+
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
+
* Email: <your email address so we can contact you, invite you to meetings, etc.>
+
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->
+
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
+
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
+
-->
+
  
== Current status ==
+
{{Admon/note | This will be explained in more details in the link.}}
* Targeted release: [[Releases/<number> | Fedora <number> ]]
+
=== The process ===
* Last updated: (DATE)
+
* Change Proposal is submitted according to the Change Proposal Submission policy
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page
+
* The formal correctness of Proposed Change page is checked by the Wrangler
Bugzilla states meaning as usual:
+
* Once the Change Proposal is correct, it's announced on Fedora Devel Announce list by the Wrangler.
NEW -> change proposal is submitted and announced
+
* After a week on mailing list FESCo will discuss the change on their meeting.
ASSIGNED -> accepted by FESCo with on going development
+
** Optionally, the change is assigned to one of the FESCo members/or trusted community member within the functional area, who follows detailed status of the change with FESCo and helps with processes within Fedora (e.g. communicate about high-impact aspects, point out that a buildroot will be neccessary). The shepherd follows on status of the change until final release.
MODIFIED -> change is substantially done and testable
+
** Fedora QA reviews announced changes on Devel Announce list to commit to testing of the change and/or adjust release criteria in case of need
optional ON_QA -> change is tested by Fedora QA
+
* Status of complex changes will be re-reviewed by FESCo one week before Beta FreezeAt this time FESCo will typically decide whether to activate the contingency plan. Changes for which FESCo can't make this decision one week before beta need to note it on the respective Change wiki page.
FIXED as NEXTRELEASE -> change is completed and will be delivered in next release under development
+
-->
+
* Tracker bug: <will be assigned by the Wrangler>
+
 
+
== Detailed Description ==
+
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
+
 
+
== Benefit to Fedora ==
+
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new functionality, what capabilities does it bring? Why will Fedora become a better distribution or project because of this proposal?-->
+
 
+
== Scope ==
+
<!-- What work do the developers have to accomplish to complete the change in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+
 
+
* Feature owners:
+
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+
 
+
* Other developers: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+
 
+
* Release engineering: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuid required?  If a rel-eng ticket exists, add a link here.  -->
+
 
+
* Policies and guidelines: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
<!-- Do the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. -->
+
 
+
== Upgrade/compatibility impact ==
+
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
+
 
+
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
N/A (not a System Wide Change)
+
 
+
== How To Test ==
+
<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.  
+
 
+
Remember that you are writing this how to for interested testers to use to check out your change implementation - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your change.
+
 
+
A good "how to test" should answer these four questions:
+
 
+
0. What special hardware / data / etc. is needed (if any)?
+
1. How do I prepare my system to test this change? What packages
+
need to be installed, config files edited, etc.?
+
2. What specific actions do I perform to check that the change is
+
working like it's supposed to?
+
3. What are the expected results of those actions?
+
-->
+
 
+
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
N/A (not a System Wide Change)
+
 
+
== User Experience ==
+
<!-- If this change proposal is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
+
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
N/A (not a System Wide Change)
+
 
+
== Dependencies ==
+
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this change depends?  In other words, completion of another change owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel change)? -->
+
 
+
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
N/A (not a System Wide Change)
+
 
+
== Contingency Plan ==
+
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages). If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy. -->
+
* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
+
* Contingency deadline: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
+
* Blocks release? N/A (not a System Wide Change), Yes/No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
 
+
== Documentation ==
+
<!-- Is there upstream documentation on this change, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
+
 
+
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
N/A (not a System Wide Change)
+
 
+
== Release Notes ==
+
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
+
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concernsIf there are any such changes involved in this change, indicate them here.  A link to upstream documentation will often satisfy this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release.  
+
 
+
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.
+
-->
+
 
+
[[Category:ChangePageIncomplete]]
+
<!-- When your change proposal page is completed and ready for review and announcement -->
+
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
+
<!-- The Wrangler announces the Change to the devel-announce list and changes the category to Category:ChangeAnnounced (no action required) -->
+
<!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->
+
 
+
<!-- Select proper category, default is Self Contained Change -->
+
[[Category:SelfContainedChange]]
+
<!-- [[Category:SystemWideChange]] -->
+

Revision as of 10:53, 10 April 2013

Idea.png
Quick Links
If you know the process already, you can jump immediately to an empty feature form.

Contents

Fedora Releases Planning Process

Motivation behind the planning process is to raise the visibility of planned changes, to make coordination and planning effort easier, as otherwise it is nearly impossible to follow all changes happening in such a big project as Fedora is. It has to be easy to submit the Change Proposal, as early as possible, before the change is implemented and even in very early state of idea, to gather community feedback and review.

The list of accepted changes (Change Set) is used by different teams across the project, for example to prepare external facing materials like Release notes and Release announcements.

Planning process is an internal planning and tracking tool and the final release does not have to reflect all proposed changes.

Changes Categories

Fedora Engineering and Steering Committee (FESCo) defined two Change categories:

  1. Self Contained Changes
  2. System Wide Changes

Self Contained Changes

The self contained changes are changes to isolate package(s) or generally all changes with limited scope and impact on the rest of distribution/project. For example addition of a group of leaf packages or coordinated effort within SIG with limited impact outside SIG functional area. Self Contained Changes could be used for early idea state proposals for wider and complex changes.

Public announcement of the new Self Contained Changes helps to co-operate on the change and extends proposed change visibility. Change owners may find help from the community or useful comments. These changes don't have to be thoroughly reviewed by FESCo. Based on the community review, Self Contained Change can be updated to the System Wide Change category and Owner can be asked to provide more details and extend Change Proposal Papge.

Note.png
This will be explained in more details in the link.

The process for Self Contained Features

  • Change Proposal is submitted according to the Change Proposal Submission policy
  • The formal correctness of Proposed Change page is checked by the Wrangler
  • Once the Change Proposal is correct, it's announced on Fedora Devel Announce list by the Wrangler.
  • No documentation process (optional), only release notes advertisement
  • Aggregated list of Change Proposals is added to FESCo agenda no sooner than a week (or more) after the announcement on the mailing list.
    • In case of no complaints (possible breakage/conflicts, coordination needed) on Fedora Devel mailing list/or from FESCo members, FESCo approves those Change Proposals without more scope and etc. investigation. Every team on Fedora devel can share their views and escalate proposed change to FESCo to go through the regular System Wide Changes process. Change owner could be asked to provide more details/or move the change to the "complex changes" category. FESCo members are encouraged to ask questions on the mailing list instead of waiting for the meeting.

Complex System Wide Changes

Complex System Wide Changes are system-wide/defaults or critical path components changing changes which does not belong to Self Contained Changes.

Note.png
This will be explained in more details in the link.

The process

  • Change Proposal is submitted according to the Change Proposal Submission policy
  • The formal correctness of Proposed Change page is checked by the Wrangler
  • Once the Change Proposal is correct, it's announced on Fedora Devel Announce list by the Wrangler.
  • After a week on mailing list FESCo will discuss the change on their meeting.
    • Optionally, the change is assigned to one of the FESCo members/or trusted community member within the functional area, who follows detailed status of the change with FESCo and helps with processes within Fedora (e.g. communicate about high-impact aspects, point out that a buildroot will be neccessary). The shepherd follows on status of the change until final release.
    • Fedora QA reviews announced changes on Devel Announce list to commit to testing of the change and/or adjust release criteria in case of need
  • Status of complex changes will be re-reviewed by FESCo one week before Beta Freeze. At this time FESCo will typically decide whether to activate the contingency plan. Changes for which FESCo can't make this decision one week before beta need to note it on the respective Change wiki page.