cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache CXF Documentation > Architectural Decisions
Date Sat, 19 Feb 2011 12:30:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2036/9/1/_/styles/combined.css?spaceKey=CXF20DOC&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/CXF20DOC/Architectural+Decisions">Architectural
Decisions</a></h2>
    <h4>Page  <b>added</b> by             <a href="https://cwiki.apache.org/confluence/display/~christian%2Bschneider">Christian
Schneider</a>
    </h4>
         <br/>
    <div class="notificationGreySide">
         <p><b>work in progresss</b></p>

<div>
<ul>
    <li><a href='#ArchitecturalDecisions-DecisionProcess'>Decision Process</a></li>
    <li><a href='#ArchitecturalDecisions-Howtodocumentarchitecturaldecisions'>How
to document architectural decisions</a></li>
<ul>
    <li><a href='#ArchitecturalDecisions-Template%3AShortonelinesummaryofthedecision'>Template:
Short one line summary of the decision</a></li>
<ul>
    <li><a href='#ArchitecturalDecisions-Reasonsforthedecision'>Reasons for the
decision</a></li>
    <li><a href='#ArchitecturalDecisions-Alternatives'>Alternatives</a></li>
<ul>
    <li><a href='#ArchitecturalDecisions-Alternative1'>Alternative 1</a></li>
    <li><a href='#ArchitecturalDecisions-Alternative2'>Alternative 2</a></li>
</ul>
</ul>
</ul>
</ul></div>

<h1><a name="ArchitecturalDecisions-DecisionProcess"></a>Decision Process</h1>

<p>Our process of decision making is derived from how the Apache Foundation works. (see
<a href="http://www.apache.org/foundation/how-it-works.html#management" class="external-link"
rel="nofollow">http://www.apache.org/foundation/how-it-works.html#management</a>).
All decisions about the CXF architecture are made by the PMC members. Decisions should be
based on consensus. Not every decision requires a vote. The PMC does also aprove to e.g. a
code change by not acting against it.</p>

<p>The current decisions should be respected when changing code. If a decision does
not apply anymore it can be changed at any time according to the rules of decision making
above. </p>

<h1><a name="ArchitecturalDecisions-Howtodocumentarchitecturaldecisions"></a>How
to document architectural decisions</h1>

<p>Every decision should be documented according to the following template. For every
decision the alternatives and reasons for the decision should be documented to make it easier
for new committers to understand why the decision was made. Additionally this scheme of documenting
decisions makes it easier to see when it is time to change the decision.</p>

<h2><a name="ArchitecturalDecisions-Template%3AShortonelinesummaryofthedecision"></a>Template:
Short one line summary of the decision</h2>

<p>Longer description of the decision.</p>

<h3><a name="ArchitecturalDecisions-Reasonsforthedecision"></a>Reasons for
the decision</h3>

<p>Resons explained. Should also contain a reference to the discussion (e.g. on mailing
list) and when the decision was made.</p>

<h3><a name="ArchitecturalDecisions-Alternatives"></a>Alternatives</h3>

<h4><a name="ArchitecturalDecisions-Alternative1"></a>Alternative 1</h4>

<h4><a name="ArchitecturalDecisions-Alternative2"></a>Alternative 2</h4>
    </div>
    <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
       </div>
       <a href="https://cwiki.apache.org/confluence/display/CXF20DOC/Architectural+Decisions">View
Online</a>
              |
       <a href="https://cwiki.apache.org/confluence/display/CXF20DOC/Architectural+Decisions?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
           </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message