Major release scheduling guidelines
The Steering Working Group has the role of defining major releases of DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. and shaping their content. This section discusses the objectives for defining major releases and guidelines that the Steering Working Group (SWG) must follow in scheduling major releases.
Objectives of defining major releases
- To identify and communicate to users of DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. when changes will happen that could affect them in a profound way, e.g.
- Changes to existing functionality that may create challenges for upgrading
- Changes to technology architecture that may create challenges for upgrading
- Introduction of major new functionality that may affect how users use DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. going forward
- To help developers of DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. understand the roadmap for the most critical changes to the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data., so they can better plan their work
- To promote planned and new DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. capabilities to encourage adoption
Objectives of defining guidelines for scheduling and approving major releases
- To ensure that major releases are planned, scheduled, and approved in a predictable, consistent, and transparent way
- Ensure smoother development
- Reduce conflict
- To ensure that we follow industry best-practices for evolving software.
Overall principles for scheduling major releases
- Major releases shall be planned ahead of time and these plans reviewed and approved by the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG so that consumers of DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. are aware of the planned changes and can plan for those changes. There is a balance between moving too quickly (and creating many changes, potentially discouraging adoption) and moving too slowly (and not addressing major issues in a timely fashion). The DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG will be tasked with assessing and maintaining that balance and communicating its decisions. That balance is likely to change over time as the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. software matures; likely major release frequency will slow down in the future.
- Part of the role of the guidelines will be to help the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG to resist pressure to create too many major releases. However, the guidelines need to provide the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG with enough flexibility to address major challenges relatively quickly and flexibly when required.
- Defining the guidelines is important to implement the above objective
Detailed guidelines – scheduling major releases
-
No major release will be planned/scheduled (decision and content) without formal approval at a meeting of the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: Designation of a major release is an important decision that requires transparency and control
-
The intention is that major releases shall be planned and reviewed at the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG at least 3 months ahead of the anticipated release date.
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: Giving the community advance warning of major changes will help DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. users plan for how they will use DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. and avoid major surprises. It will also help DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. developers plan their own changes
-
It is anticipated that for at least the next several years (say 4-5) at least one major release will be planned each year.
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: we anticipate that there will be an accumulation of desired changes that cannot be accommodated within a minor release and we wish to ensure that these can be addressed without undue delay
-
Any addition to the scope/contents of (or technical change to) a planned major release requires DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG approval
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: similar to the above guideline on scheduling major releases
-
If planned scope items for a major release are not available in time for the planned release date, the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG will need to decide whether to slip the release date or drop the item, based on industry priorities
-
These guidelines can be overridden in exceptional circumstances by a formal vote of the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG.
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: Sometimes unanticipated issues will come up and we need the ability to move quickly in these cases. However, there should be an explicit decision process when breaking a guideline.
-
These guidelines can be amended by the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG following a formal review process
Detailed guidelines – long-term planning and outreach
-
Ideally the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG will establish plans for upcoming major releases for at least the following 9-12 months
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: this providesIDE Integrated Development Environment. A software application that brings together all the essential tools a developer needs to write, test and debug code in one unified workspace. transparency for the users and potential users of DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. (supporting adoption)
-
Major release schedules shall be published on the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. GitHub repository once approved by the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG (in the roadmap).
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: as above
Detailed guidelines – changes vs major versions
-
Breaking changes (as defined in the change control guidelines) can only be implemented in a major version
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: this is required to ensure that within a single major version there is stability across minor versions.
-
Changes (PRsPR Pull request) will be categorized into those that can only be done in major releases (because they contain breaking changes) and others. PRsPR Pull request requiring a major release shall only be approved for major releases.
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: this is necessary to ensure that the meaning of major releases is enforced
-
Even in a new major version, changes that are contrary to the change control guidelines will not be approved unless the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG executes an exception process.
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: this is required to ensure that DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. providesIDE Integrated Development Environment. A software application that brings together all the essential tools a developer needs to write, test and debug code in one unified workspace. stability across major versions, in terms of functionality that is supported
-
When a major version includes breaking changes, the DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. SWG will endeavour to ensure that appropriate migration guidesIDE Integrated Development Environment. A software application that brings together all the essential tools a developer needs to write, test and debug code in one unified workspace. and transition plans are in place
- Rationalerationale An optional explanatory note added to a `regulatoryReference` to clarify why the rule’s functional logic is written the way it is.: this is to support DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data. users in migrating to new versions of DRRDRR Digital Regulatory Reporting. An industry‑developed, machine‑executable interpretation of regulatory rules that produces consistent, transparent and fully traceable reporting outputs from standardised CDM data.