Templates for requests

From OTBWiki
Jump to: navigation, search

[Request for Comments - 1] Template for request for comments

Status

  • Author: John Doe
  • Submitted on 01.01.2000
  • Open for comments / development / closed / abandoned

Content

What changes will be made and why they would make a better Orfeo ToolBox?

High level description of proposed changes, with analysis of risk, benefits, different solutions ...

When will those changes be available (target release or date)?

Those changes can be available for release x.y.

Who will be developing the proposed changes?

Community

Comments

List here important comments (possibly links) received.

Support

List here community members that support this RFComments.

Corresponding Requests for Changes

List here links to corresponding Requests for Changes if any.

[Request for Changes - 1] Name of the request for changes

Status

  • Author:
  • Additional Contributors (if different than authors)
  • Submitted on dd.mm.yyyy
  • Proposed target release
  • Adopted / Rejected (with vote results)
  • Link to a public git branch or pull request corresponding to the changes.
  • Merged : (put merge commit when merged)

Summary

Gives a short summary of the changes.

Rationale

Explain the rationale for the changes (possible link to a [Request For Comments] or to a mantis ticket).

Implementation details

Classes and files

List impacted modules, classes and files, and explain the changes that were made.

Consider grouping changes by module names if several modules are impacted.

Give insight on important implementation details, and on all API changes (add link to specific changesets if possible).

Applications

List impacted applications, and explain the changes that were made.

Consider grouping changes by module names if several modules are impacted.

Give insight on important implementation details, and on all API changes (add link to specific changesets if possible).

Tests

List impacted tests, and explain the changes that were made.

Consider grouping changes by module names if several modules are impacted.

Link to dashboard pages of impacted if possible.

Documentation

List documentation modification that were made (doxygen, example, software guide, application documentation, cookbook).

Additional notes

List remaining open issues if any, and additional notes.