XS Community Edition/Features/template
Comments and Explanations:
Copy the source of this template to a new page named Feature/Your Feature Name before making changes! DO NOT EDIT THIS TEMPLATE BY MISTAKE.
A sentence or two summarizing what this feature is and what it will do. This information is used for the overall feature summary page for each release.
This should link to your home wiki page so we know who you are
- Name: Your Name
Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved
- Email: <your email address so we can contact you, invite you to meetings, etc.>
- Targeted release: (XSCD_VERSION)
- Last updated: (DATE)
- Percentage of completion: XX%
Expand on the summary, if appropriate. A couple of sentences suffices to explain the goal, but the more details you can provide the better.
Benefit to XS(CD)
What is the benefit to the platform? If this is a major capability update, what has changed? If this is a new feature, what capabilities does it bring? Why will XS(CD) become a better platform or project because of this feature?
Make sure to note here as well if this feature has been requested by a specific deployment, or if it has emerged from a bug report.
What work do the 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?
Does the feature have a direct impact on the work flow, or does it need a UI? Link here mockups, or add detailed descriptions.
How To Test
Testing notes go here
If this feature is noticeable by its target audience, how will their experiences change as a result? Describe what they will see or notice.
What other packages (RPMs) depend on this package? Are there changes outside the developers' control on which completion of this feature depends? In other words, does your feature depend on completion of another feature owned by someone else or that you would need to coordinate, which might cause you to be unable to finish on time? Other upstream projects like Python?
If you cannot complete your feature by the final development freeze, what is the backup plan? This might be as simple as "None necessary, revert to previous release behaviour." Or it might not. If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.
Is there upstream documentation on this feature, or notes you have written yourself? Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.
The XS(CE) Release Notes inform end-users about what is new in the release. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the release team and shipped with the release.