openstack/governance
Code Issues Proposed changes
2a9ac9ce4c
governance/resolutions/20140402-defcore-designated-sections-guidelines.rst
Doug Hellmann 37178d955d Update sphinx doc formatting and toctrees 
Create index pages with toctree entries to load the existing
documents so they are all linked together.

Add titles to some of the documents that did not have them to
make them work with sphinx.

Change-Id: I0d44cfe1a75ab7df07e0efc989eb7cf161d9bf78
2014-05-06 16:45:00 -04:00

985 B
Raw Blame History

2014-04-02 DefCore Designated Sections Guidelines

This resolution is about formally approving the general selection principles for "designated sections" of code, as part of the DefCore effort.

Sections of code should generally be DESIGNATED when:

  • code provides the project external REST API, or
  • code is shared and provides common functionality for all options, or
  • code implements logic that is critical for cross-platform operation

Sections of code should generally NOT be DESIGNATED when:

  • code interfaces to vendor-specific functions, or
  • project design explicitly intended this section to be replaceable, or
  • code extends the project external REST API in a new or different way, or
  • code is being deprecated

Code that is not clearly designated is assumed to be designated unless determined otherwise. The default assumption will be to consider code designated.