From Fedora Project Wiki
(Update for changes that requires rel-eng changes - https://fedorahosted.org/fesco/ticket/1424)
(10 intermediate revisions by 4 users not shown)
Line 6: Line 6:


The list of accepted changes, or change set, is used by different teams across the project. For example, the change set may be used to prepare external facing materials like release notes and release announcements.  
The list of accepted changes, or change set, is used by different teams across the project. For example, the change set may be used to prepare external facing materials like release notes and release announcements.  
Change owners are trusted ''and depended upon'' to highlight all relevant changes. Not noting important changes (whether due to oversight, different opinion of importance, or intentionally) breaks the Change process.


The planning process is an internal planning and tracking tool, and the final release is not required to reflect all proposed changes.   
The planning process is an internal planning and tracking tool, and the final release is not required to reflect all proposed changes.   
Line 15: Line 17:


=== Self contained changes ===
=== Self contained changes ===
A self contained change is a change to isolated package(s), or a general changes with limited scope and impact on the rest of distribution/project. Examples include addition of a group of leaf packages, or a coordinated effort within a [[SIG]] with limited impact outside the SIG's functional area. Self contained changes could be used for early idea state proposals for wider and complex changes.
A self contained change is a change to isolated package(s), or a general change with limited scope and impact on the rest of distribution/project. Examples include addition of a group of leaf packages, or a coordinated effort within a [[SIG]] with limited impact outside the SIG's functional area. Self contained changes could be used for early idea state proposals for wider and complex changes.


Public announcement of a new self contained change promotes cooperation on the change, and extends its 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, the self contained change can be updated to the complex system wide change category, and the owner may be asked to provide more details and extend the change proposal page.
Public announcement of a new self contained change promotes cooperation on the change, and extends its 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, the self contained change can be updated to the complex system wide change category, and the owner may be asked to provide more details and extend the change proposal page.
Line 36: Line 38:
* Once the change proposal is correct, the Wrangler announces it on the {{fplist|devel-announce}} list.
* Once the change proposal is correct, the Wrangler announces it on the {{fplist|devel-announce}} list.
* After at least one week on the mailing list, the Wrangler sends the change to FESCo for discussion and formal approval in their meeting.
* After at least one week on the mailing list, the Wrangler sends the change to FESCo for discussion and formal approval in their meeting.
** Optionally, FESCo assigns the change to one of the FESCo members or a trusted community member within the functional area (a ''change shepherd''), who follows the detailed status of the change with FESCo and helps with processes within Fedora. For example, the change shepherd may communicate high-impact aspects of the change, or point out that a buildroot will be neccessary. The shepherd follows the status of the change until final release.
** Optionally, FESCo assigns the change to one of the FESCo members or a trusted community member within the functional area (a ''change shepherd''), who follows the detailed status of the change with FESCo and helps with processes within Fedora. For example, the change shepherd may communicate high-impact aspects of the change, or point out that a buildroot will be neccessary. The shepherd follows the status of the change until final release.
** Fedora QA reviews announced changes on the {{fplist|devel-announce}} list to commit to testing of the change, or adjust release criteria as necessary.
** Fedora QA reviews announced changes on the {{fplist|devel-announce}} list to commit to testing of the change, or adjust release criteria as necessary.
* FESCo will re-review the status of complex changes one week before the [[Milestone freezes|Beta freeze]] ([[Schedule|see current schedule]]). At this time, FESCo typically decides whether to activate the contingency plan. Any change for which FESCo can't make this decision one week before beta must include a note on its Change wiki page and tracking bug.
* FESCo will re-review the status of complex changes one week before the [[Milestone freezes|Beta freeze]] ([[Schedule|see current schedule]]). At this time, FESCo typically decides whether to activate the contingency plan. Any change for which FESCo can't make this decision one week before beta must include a note on its Change wiki page and tracking bug.
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
* For changes that require modifications to the [[Packaging:Guidelines|Fedora Packaging Guidelines]]:
 
** The person or group proposing the Change is responsible for providing a first draft of packaging guideline changes to the FPC
 
** This draft does not need to be prepared prior to submitting the Change request, but must be complete by Alpha Freeze or the Contingency Plan will be invoked.
== Essential Communications ==
* For changes which require Release Engineering involvement:  
 
** Please work with releng prior to feature submission, and ensure that someone is on board to do any process development work and testing; don't just assume that a bullet point in a change puts someone else on the hook
=== Fedora Packaging Committee ===
** File a ​ticket with Release Engineering immediately when the change is accepted, with a detailed breakdown of changes needed  
For changes that require modifications to the [[Packaging:Guidelines|Fedora Packaging Guidelines]]:
** Work must be substantially complete and in place by Alpha Freeze or the contingency plan will be invoked.
* The person or group proposing the Change is responsible for providing a first draft of packaging guideline changes to the FPC.
* This draft does not need to be prepared prior to submitting the Change request, but must be complete by Alpha Freeze or the Contingency Plan will be invoked.
 
=== Release Engineering ===
For all changes you need to file an issue in [https://pagure.io/releng/issues releng pagure] to check if your change requires Release Engineering involvement:
* You must work with releng prior to feature submission, and ensure that someone is on board to do any process development work and testing; don't just assume that a bullet point in a change puts someone else on the hook.
** File a ​ticket with Release Engineering when working on your change and link to it in your change page, with a detailed breakdown of changes needed.
* Work must be substantially complete and in place by Alpha Freeze or the contingency plan will be invoked.
 
=== Trademark Approval ===
 
If your Change may require trademark approval (for example, if it is a new Spin), [https://fedorahosted.org/council/ file a ticket] requesting trademark approval from the [[Fedora Council]]. This approval will be done via the Council's consensus-based process; if the request receives at least three positive votes and no negative votes within an approved period, it is considered approved.
 
For Change-related trademark approval, the Council has decided that 14 days is the normal time to reach consensus. This may be extended when it seems necessary to allow an adequate period for input.


== HOWTOs ==
== HOWTOs ==
=== For everyone ===
In general, Changes are for coordination of development effort and for communication (both internally and externally). They aren't mandates that someone else implement an idea (no matter how good that idea). If you have improvement in mind, work to get implementers committed to the effort ''before'' filing a Change, rather than expecting them to show up for work once the Change is accepted — that's simply unlikely to happen and the effort will likely fail, leading to sadness and disappointment all around.
=== For developers ===
=== For developers ===
{{hidden|header=How do I propose a new change?|content=
 
==== How do I propose a new change? ====
In order to be considered an official change proposal accepted for the next Fedora release, the change proposal must be formally documented on a separate wiki page.
In order to be considered an official change proposal accepted for the next Fedora release, the change proposal must be formally documented on a separate wiki page.
# Read the policies for self contained changes and complex system wide changes mentioned above.
# Read the policies for self contained changes and complex system wide changes mentioned above.
Line 59: Line 80:


The [[Change_Wrangler]] is responsible for the actual announcement of the change proposal, creating the FESCo ticket and tracking bug in Bugzilla. For status tracking, see the next section.
The [[Change_Wrangler]] is responsible for the actual announcement of the change proposal, creating the FESCo ticket and tracking bug in Bugzilla. For status tracking, see the next section.
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}


{{hidden|header=How is a change accepted?|content=
{{admon/tip | ''Change Template'' | Start with the [[Changes/EmptyTemplate | empty change proposal template]] — but don't edit it; copy its contents to a new wiki page and work from there.}}
 
==== How is a change accepted? ====
Self contained changes that pass community review (the announcement) are accepted by FESCo without further investigation in a batch, no sooner than one week after the announcement. Complex system wide changes must be accepted by FESCo individually in the weekly meeting. The scope and dependencies are thoroughly reviewed to determine influence on the other parts of Fedora. It's beneficial for the change proposal owner to be available in the FESCo ticket for the change proposal, and in the relevant FESCo meeting (announced in advance). The change proposal owner is notified when the change is accepted for inclusion in the planned release.
Self contained changes that pass community review (the announcement) are accepted by FESCo without further investigation in a batch, no sooner than one week after the announcement. Complex system wide changes must be accepted by FESCo individually in the weekly meeting. The scope and dependencies are thoroughly reviewed to determine influence on the other parts of Fedora. It's beneficial for the change proposal owner to be available in the FESCo ticket for the change proposal, and in the relevant FESCo meeting (announced in advance). The change proposal owner is notified when the change is accepted for inclusion in the planned release.
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}


{{hidden|header=How do I show the status of a change I own?|content=
==== How do I show the status of a change I own? ====
The progress of development is shown in Bugzilla with defined bug states as explained in the change proposal template. Use this tracking bug to show blockers, using the Blocks/Depends on fields (for example package reviews), update the bug description with an actual status, and modify the bug status to reflect current state. You may be asked by the [[Change_Wrangler]] or FESCo members to provide more detailed status (specifically for complex system wide changes).
The progress of development is shown in Bugzilla with defined bug states as explained in the change proposal template. Use this tracking bug to show blockers, using the Blocks/Depends on fields (for example package reviews), update the bug description with an actual status, and modify the bug status to reflect current state. You may be asked by the [[Change_Wrangler]] or FESCo members to provide more detailed status (specifically for complex system wide changes).
   
   
A Change is considered ''code complete'' when the bug state is moved to ON_QA and when there are no blocking bugs open.
A Change is considered ''code complete'' when the bug state is moved to ON_QA and when there are no blocking bugs open.
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}


{{hidden|header= What are the change process deadline dates (Checkpoints)?|content=
==== What are the change process deadline dates (Checkpoints)? ====
For specific dates refer to the current release's [[Schedule]]. For the general template of a Fedora release, to see when the Change Checkpoints relate to the rest of the cycle, see [[Fedora_Release_Life_Cycle]].
For specific dates refer to the current release's [[Schedule]]. For the general template of a Fedora release, to see when the Change Checkpoints relate to the rest of the cycle, see [[Fedora_Release_Life_Cycle]].


==== Change Checkpoint: Proposal submission deadline (System Wide Changes) ====
===== Change Checkpoint: Proposal submission deadline (System Wide Changes) =====
New change proposals may be submitted using the guidelines described elsewhere and accepted by [[FESCo]] until the ''change proposals submission deadline''. For a given release, this date falls three months before the release is [[Releases/Branched|Branched]], and will be announced well in advance. It's a strict deadline for System Wide Changes. Self Contained changes may be proposed after this deadline but we prefer developers to follow it as it helps with release planning.
New change proposals may be submitted using the guidelines described elsewhere and accepted by [[FESCo]] until the ''change proposals submission deadline''. For a given release, this date falls three months before the release is [[Releases/Branched|Branched]], and will be announced well in advance. It's a strict deadline for System Wide Changes. Self Contained changes may be proposed after this deadline but we prefer developers to follow it as it helps with release planning.


==== Change Checkpoint: Completion deadline ====
===== Change Checkpoint: Completion deadline =====
This deadline falls on the same day as the Alpha [[Milestone freezes|milestone freeze]] (see [[Schedule]]).
This deadline falls on the same day as the Alpha [[Milestone freezes|milestone freeze]] (see [[Schedule]]).


* New changes must be feature complete or close enough to completion by the ''Change Checkpoint: Completion deadline'' date that a majority of its functionality can be tested during the Alpha and Beta releases.
* New changes must be feature complete or close enough to completion by the ''Change Checkpoint: Completion deadline'' date that a majority of its functionality can be tested during the Alpha and Beta releases.
* If a change proposal page specifies a change will be enabled by default, it must be so by this date.
* If a change proposal page specifies a change will be enabled by default, it must be so by this date.
* Changes meeting the preceding bullets are considered ''testable.''
* Changes meeting the preceding bullets are considered ''testable''.
* Use the MODIFIED status in the tracker bug to show the change made the change deadline and is ''testable''.
* Use the MODIFIED status in the tracker bug to show the change made the change deadline and is ''testable''.
{{Admon/tip | ''Testable'' | This means the change is substantially complete and can be tested when the change is not 100% completely implemented. This is an attempt to provide some flexibility without completely losing the understood meaning of a change being ''feature complete''. All new changes are tested during the Alpha and Beta releases.}}
{{Admon/tip | ''Testable'' | This means the change is substantially complete and can be tested when the change is not 100% completely implemented. This is an attempt to provide some flexibility without completely losing the understood meaning of a change being ''feature complete''. All new changes are tested during the Alpha and Beta releases.}}
{{admon/warning| ''Cutting it close?'' | At this point, Rawhide and the immediately-upcoming "N+1" release are already separate branches. If development, testing, integration — and integration testing! — are not really all lined up by this point, there is no shame in re-targeting for the ''next'' (N+2) release. Now is the time for you to bring that to [[FESCo]]. Or, if this change is time-sensitive but needs more resources or attention from across the community, bring ''that'' to FESCo, to  the Fedora [[Council]], and to the Fedora community at large.}}


==== Change Checkpoint: 100% code complete deadline ====
===== Change Checkpoint: 100% code complete deadline =====
This date falls on the same day as the [[Schedule|Beta Freeze]].
This date falls on the same day as the [[Schedule|Beta Freeze]].


Line 93: Line 114:


{{admon/note|Relationship to milestone freezes|Change Checkpoint: 100% code complete deadline coincides with the [[Milestone freezes|Beta Freeze]] date because that is the last date on which it can be ensured that a build will appear in a milestone release. The idea is really that these requirements be met in the Beta ''release'', but due to the nature of the milestone freezes, in order to ensure this is the case, the requirements must be met by the freeze date.}}
{{admon/note|Relationship to milestone freezes|Change Checkpoint: 100% code complete deadline coincides with the [[Milestone freezes|Beta Freeze]] date because that is the last date on which it can be ensured that a build will appear in a milestone release. The idea is really that these requirements be met in the Beta ''release'', but due to the nature of the milestone freezes, in order to ensure this is the case, the requirements must be met by the freeze date.}}
|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 
<!--
<!--
=== For documentation team ===
=== For documentation team ===

Revision as of 16:40, 7 February 2017

Idea.png
Quick Links
If you know the process already, you can jump immediately to an empty Change Proposal form. Looking for help? Contact the Change Wrangler.

Fedora Release Planning Process

The motivation for the planning process is to raise the visibility of planned changes and make coordination and planning effort easier. Otherwise it is nearly impossible to follow all changes happening in a big project such as Fedora. It must be easy to submit the change proposal as early as possible, before the change is implemented and even in the very early state of the idea, to gather community feedback and review.

The list of accepted changes, or change set, is used by different teams across the project. For example, the change set may be used to prepare external facing materials like release notes and release announcements.

Change owners are trusted and depended upon to highlight all relevant changes. Not noting important changes (whether due to oversight, different opinion of importance, or intentionally) breaks the Change process.

The planning process is an internal planning and tracking tool, and the final release is not required to reflect all proposed changes.

Change categories

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

  1. Self contained changes
  2. Complex system wide changes

Self contained changes

A self contained change is a change to isolated package(s), or a general change with limited scope and impact on the rest of distribution/project. Examples include addition of a group of leaf packages, or a coordinated effort within a SIG with limited impact outside the SIG's functional area. Self contained changes could be used for early idea state proposals for wider and complex changes.

Public announcement of a new self contained change promotes cooperation on the change, and extends its 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, the self contained change can be updated to the complex system wide change category, and the owner may be asked to provide more details and extend the change proposal page.

The process for self contained changes
  • The owner submits the change proposal according to the change proposal submission policy.
  • The Change_Wrangler checks the proposed change page for formal correctness.
  • Once the change proposal is correct, the Wrangler announces it on the devel-announce mailing list.
  • WHO? advertises the change in the release notes. Other formal documentation process is optional.
  • The Wrangler adds the aggregated list of change proposals to the FESCo agenda no sooner than a week after the announcement on the mailing list.
    • In case of no complaints (possible breakage/conflicts, coordination needed) on the devel mailing list or from FESCo members, FESCo approves those change proposals without further investigation or scoping. Any team can share their views on devel and escalate a proposed change to FESCo to go through the regular complex system wide changes process. The change owner may be asked to provide more details or move the change to the "complex system wide 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 involve system-wide defaults, critical path components, or other changes that are not eligible as self contained changes.

The process for complex system wide changes
  • The owner submits the change proposal according to the change proposal submission policy below.
  • The Change Wrangler checks the proposed change page for formal correctness.
  • Once the change proposal is correct, the Wrangler announces it on the devel-announce list.
  • After at least one week on the mailing list, the Wrangler sends the change to FESCo for discussion and formal approval in their meeting.
    • Optionally, FESCo assigns the change to one of the FESCo members or a trusted community member within the functional area (a change shepherd), who follows the detailed status of the change with FESCo and helps with processes within Fedora. For example, the change shepherd may communicate high-impact aspects of the change, or point out that a buildroot will be neccessary. The shepherd follows the status of the change until final release.
    • Fedora QA reviews announced changes on the devel-announce list to commit to testing of the change, or adjust release criteria as necessary.
  • FESCo will re-review the status of complex changes one week before the Beta freeze (see current schedule). At this time, FESCo typically decides whether to activate the contingency plan. Any change for which FESCo can't make this decision one week before beta must include a note on its Change wiki page and tracking bug.


Essential Communications

Fedora Packaging Committee

For changes that require modifications to the Fedora Packaging Guidelines:

  • The person or group proposing the Change is responsible for providing a first draft of packaging guideline changes to the FPC.
  • This draft does not need to be prepared prior to submitting the Change request, but must be complete by Alpha Freeze or the Contingency Plan will be invoked.

Release Engineering

For all changes you need to file an issue in releng pagure to check if your change requires Release Engineering involvement:

  • You must work with releng prior to feature submission, and ensure that someone is on board to do any process development work and testing; don't just assume that a bullet point in a change puts someone else on the hook.
    • File a ​ticket with Release Engineering when working on your change and link to it in your change page, with a detailed breakdown of changes needed.
  • Work must be substantially complete and in place by Alpha Freeze or the contingency plan will be invoked.

Trademark Approval

If your Change may require trademark approval (for example, if it is a new Spin), file a ticket requesting trademark approval from the Fedora Council. This approval will be done via the Council's consensus-based process; if the request receives at least three positive votes and no negative votes within an approved period, it is considered approved.

For Change-related trademark approval, the Council has decided that 14 days is the normal time to reach consensus. This may be extended when it seems necessary to allow an adequate period for input.

HOWTOs

For everyone

In general, Changes are for coordination of development effort and for communication (both internally and externally). They aren't mandates that someone else implement an idea (no matter how good that idea). If you have improvement in mind, work to get implementers committed to the effort before filing a Change, rather than expecting them to show up for work once the Change is accepted — that's simply unlikely to happen and the effort will likely fail, leading to sadness and disappointment all around.

For developers

How do I propose a new change?

In order to be considered an official change proposal accepted for the next Fedora release, the change proposal must be formally documented on a separate wiki page.

  1. Read the policies for self contained changes and complex system wide changes mentioned above.
  2. Pick the right category. Remember, the category can be changed to another one based on community or FESCo review!
  3. Fill in the empty change proposal form with all details required for selected category (see inline comments).
  4. Once you're satisfied with the change proposal page, set the wiki page category to Category:ChangeReadyForWrangler, and set the appropriate change category -- Category:SelfContainedChange or Category:SystemWideChange. Both categories must be set! Also ensure that the proposal URL follows the "Changes/<proposalname>" scheme.
  5. Make sure to finish your change proposal by the change proposal submission deadline! If you do not meet this deadline, you must seek an exception from FESCo.

The Change_Wrangler is responsible for the actual announcement of the change proposal, creating the FESCo ticket and tracking bug in Bugzilla. For status tracking, see the next section.

Idea.png
Change Template
Start with the empty change proposal template — but don't edit it; copy its contents to a new wiki page and work from there.

How is a change accepted?

Self contained changes that pass community review (the announcement) are accepted by FESCo without further investigation in a batch, no sooner than one week after the announcement. Complex system wide changes must be accepted by FESCo individually in the weekly meeting. The scope and dependencies are thoroughly reviewed to determine influence on the other parts of Fedora. It's beneficial for the change proposal owner to be available in the FESCo ticket for the change proposal, and in the relevant FESCo meeting (announced in advance). The change proposal owner is notified when the change is accepted for inclusion in the planned release.

How do I show the status of a change I own?

The progress of development is shown in Bugzilla with defined bug states as explained in the change proposal template. Use this tracking bug to show blockers, using the Blocks/Depends on fields (for example package reviews), update the bug description with an actual status, and modify the bug status to reflect current state. You may be asked by the Change_Wrangler or FESCo members to provide more detailed status (specifically for complex system wide changes).

A Change is considered code complete when the bug state is moved to ON_QA and when there are no blocking bugs open.

What are the change process deadline dates (Checkpoints)?

For specific dates refer to the current release's Schedule. For the general template of a Fedora release, to see when the Change Checkpoints relate to the rest of the cycle, see Fedora_Release_Life_Cycle.

Change Checkpoint: Proposal submission deadline (System Wide Changes)

New change proposals may be submitted using the guidelines described elsewhere and accepted by FESCo until the change proposals submission deadline. For a given release, this date falls three months before the release is Branched, and will be announced well in advance. It's a strict deadline for System Wide Changes. Self Contained changes may be proposed after this deadline but we prefer developers to follow it as it helps with release planning.

Change Checkpoint: Completion deadline

This deadline falls on the same day as the Alpha milestone freeze (see Schedule).

  • New changes must be feature complete or close enough to completion by the Change Checkpoint: Completion deadline date that a majority of its functionality can be tested during the Alpha and Beta releases.
  • If a change proposal page specifies a change will be enabled by default, it must be so by this date.
  • Changes meeting the preceding bullets are considered testable.
  • Use the MODIFIED status in the tracker bug to show the change made the change deadline and is testable.
Idea.png
Testable
This means the change is substantially complete and can be tested when the change is not 100% completely implemented. This is an attempt to provide some flexibility without completely losing the understood meaning of a change being feature complete. All new changes are tested during the Alpha and Beta releases.
Warning.png
Cutting it close?
At this point, Rawhide and the immediately-upcoming "N+1" release are already separate branches. If development, testing, integration — and integration testing! — are not really all lined up by this point, there is no shame in re-targeting for the next (N+2) release. Now is the time for you to bring that to FESCo. Or, if this change is time-sensitive but needs more resources or attention from across the community, bring that to FESCo, to the Fedora Council, and to the Fedora community at large.
Change Checkpoint: 100% code complete deadline

This date falls on the same day as the Beta Freeze.

  • New accepted changes must be code complete, meaning all the code required to enable to the new change is finished.
  • The level of code completeness is reflected as tracker bug state ON_QA. The change does not have to be fully tested by this deadline.
Note.png
Relationship to milestone freezes
Change Checkpoint: 100% code complete deadline coincides with the Beta Freeze date because that is the last date on which it can be ensured that a build will appear in a milestone release. The idea is really that these requirements be met in the Beta release, but due to the nature of the milestone freezes, in order to ensure this is the case, the requirements must be met by the freeze date.


FAQs

Feel free to ask the Change_Wrangler for help.