Author: jxue
Date: Fri May 13 04:32:04 2022
New Revision: 1900848
URL: http://svn.apache.org/viewvc?rev=1900848&view=rev
Log:
Site checkin for project Apache Helix :: Website
Modified:
helix/site-content/DevelopmentProcess.html
Modified: helix/site-content/DevelopmentProcess.html
URL:
http://svn.apache.org/viewvc/helix/site-content/DevelopmentProcess.html?rev=1900848&r1=1900847&r2=1900848&view=diff
==============================================================================
--- helix/site-content/DevelopmentProcess.html (original)
+++ helix/site-content/DevelopmentProcess.html Fri May 13 04:32:04 2022
@@ -13,7 +13,7 @@
<head>
<meta charset="UTF-8" />
- <title>Apache Helix – Development Process</title>
+ <title>Apache Helix - Development Process</title>
<meta name="viewport" content="width=device-width,
initial-scale=1.0" />
<meta name="description" content="" />
<meta http-equiv="content-language" content="en" />
@@ -187,83 +187,86 @@ KIND, either express or implied. See th
specific language governing permissions and limitations
under the License.
-->
+<hr>
+<div class="page-header">
+ <h1>Development Process</h1>
+</div>
<section>
- <h2 id="Development_Process">Development Process</h2>
- <div class="page-header">
- <h1>Project Based Development</h1>
- </div>
-</section>
-<section>
- <h2 id="Project_Proposal_.26_Review">Project Proposal & Review</h2>
+ <h2 id="Project_Based__Development">Project Based Development</h2>
<section>
- <h3 id="Overall_Steps">Overall Steps</h3>
- <p>The developer for Apache Helix should use following steps for project
based development:</p>
- <ul>
- <li>Write a Wiki to describe your proposal for the project.</li>
- <li>Send the proposal to <a
href="[email protected]">[email protected]</a> for reviewing</li>
- <li>Addressing all the comments and concerns.</li>
- <li>Get <b>AT LEAST ONE</b> approval from Apache Helix PMCs.</li>
- <li>Create your project branch and start the implementation.</li>
- <li>Make sure all tests passed before merging to the main branch.</li>
- </ul>
+ <h3 id="Project_Proposal_.26_Review">Project Proposal & Review</h3>
+ <section>
+ <h4 id="Overall_Steps">Overall Steps</h4>
+ <p>The developer for Apache Helix should use following steps for project
based development:</p>
+ <ul>
+ <li>Write a Wiki to describe your proposal for the project.</li>
+ <li>Send the proposal to <a
href="[email protected]">[email protected]</a> for reviewing</li>
+ <li>Addressing all the comments and concerns.</li>
+ <li>Get <b>AT LEAST ONE</b> approval from Apache Helix PMCs.</li>
+ <li>Create your project branch and start the implementation.</li>
+ <li>Make sure all tests passed before merging to the main branch.</li>
+ </ul>
+ </section>
+ <section>
+ <h4 id="Proposal_Guidance">Proposal Guidance</h4>
+ <p>Before the implementation, a project proposal must required for
following items documented:</p>
+ <ul>
+ <li>Problem Statement</li>
+ <li>Proposed Solutions
+ <ul>
+ <li>Architecture / Structure Change</li>
+ <li>Potential Impact</li>
+ <li>Behavior Change</li>
+ </ul> </li>
+ <li>Alternative Solutions</li>
+ <li>Roll Out Guidance for Users</li>
+ </ul>
+ <p>For all the list components must be covered in the proposal
documentation. This proposal must be submitted in the <a class="externalLink"
href="https://github.com/apache/helix/wiki";>github wiki</a> under <b>Document
Ready for Review</b> and mark title prefix with different statuses:</p>
+ <ul>
+ <li><b>[Draft]</b>: document is working in progress</li>
+ <li><b>[In Review]</b>: document is ready to be reviewed and people are
reviewing it.</li>
+ <li><b>[Done]</b>: document is reviewed and signed off by Apache Helix PMC
members.</li>
+ </ul>
+ </section>
+ <section>
+ <h4 id="Definition_of_Project">Definition of Project</h4>
+ <p>To define a project, you need to understand the complexity of the
feature you implement, improve or fixing bugs. Here're the minimum requirements
for a project based development. Any one of the item qualified, you must start
a project based development:</p>
+ <ul>
+ <li>The work need to be done is a new feature that either :
+ <ul>
+ <li>May cause multiple modules touched .</li>
+ <li>Over 200 lines code change need to be break down into small
PRs.</li>
+ <li>New modules to be added.</li>
+ </ul> </li>
+ <li>The work need to be done is improvement / bug fixing either:
+ <ul>
+ <li>Over 200 lines code change.</li>
+ <li>Impact user behavior</li>
+ <li>Impact Helix client components, such as HelixManager, Participant,
Spectator and so on.</li>
+ <li>Backward incompatible.</li>
+ <li>Require major refactoring code structure.</li>
+ </ul> </li>
+ </ul>
+ <p>Feelfree to add more items and give suggestions to <a
href="[email protected]">dev mailing list</a>.</p>
+ </section>
</section>
+</section>
+<section>
+ <h2 id="Regular_Bug_Fixing">Regular Bug Fixing</h2>
<section>
- <h3 id="Proposal_Guidance">Proposal Guidance</h3>
- <p>Before the implementation, a project proposal must required for following
items documented:</p>
- <ul>
- <li>Problem Statement</li>
- <li>Proposed Solutions
- <ul>
- <li>Architecture / Structure Change</li>
- <li>Potential Impact</li>
- <li>Behavior Change</li>
- </ul> </li>
- <li>Alternative Solutions</li>
- <li>Roll Out Guidance for Users</li>
- </ul>
- <p>For all the list components must be covered in the proposal
documentation. This proposal must be submitted in the <a class="externalLink"
href="https://github.com/apache/helix/wiki";>github wiki</a> under <b>Document
Ready for Review</b> and mark title prefix with different statuses:</p>
+ <h3 id="Bug_Fixing_Steps">Bug Fixing Steps</h3>
+ <p>For all developers who are willing to contributing to Apache Helix for
fixing bugs, please following the steps we decribed below.</p>
<ul>
- <li><b>[Draft]</b>: document is working in progress</li>
- <li><b>[In Review]</b>: document is ready to be reviewed and people are
reviewing it.</li>
- <li><b>[Done]</b>: document is reviewed and signed off by Apache Helix PMC
members.</li>
+ <li>If there is a github issue, assign that ticket to you if you are
committer. For contributors, you can leave a comment to let other committers to
assign that issue to you. If there is no issue in github, create an issue for
that.</li>
+ <li>Working on the bug fixing in your forked repo.</li>
+ <li>Submit PR based on our <a class="externalLink"
href="https://github.com/apache/helix/wiki/Pull-Request-Description-Template";>template</a></li>
+ <li>Address all review comments and follow <a class="externalLink"
href="https://github.com/apache/helix/wiki/Pull-Request-Merge-Steps";>merge
steps</a></li>
</ul>
</section>
<section>
- <h3 id="Definition_of_Project">Definition of Project</h3>
- <p>To define a project, you need to understand the complexity of the feature
you implement, improve or fixing bugs. Here're the minimum requirements for a
project based development. Any one of the item qualified, you must start a
project based development:</p>
- <ul>
- <li>The work need to be done is a new feature that either :
- <ul>
- <li>May cause multiple modules touched .</li>
- <li>Over 200 lines code change need to be break down into small PRs.</li>
- <li>New modules to be added.</li>
- </ul> </li>
- <li>The work need to be done is improvement / bug fixing either:
- <ul>
- <li>Over 200 lines code change.</li>
- <li>Impact user behavior</li>
- <li>Impact Helix client components, such as HelixManager, Participant,
Spectator and so on.</li>
- <li>Backward incompatible.</li>
- <li>Require major refactoring code structure.</li>
- </ul> </li>
- </ul>
- <p>Feelfree to add more items and give suggestions to <a
href="[email protected]">dev mailing list</a>.</p>
- <h1>Regular Bug Fixing</h1>
+ <h3 id="Relevant_Work">Relevant Work</h3>
+ <p>When you work on bug fixing and you found other things need to be done,
feel free to create issues and leave <b>TODO</b> comments in the code to avoid
make the PR larger and larger.</p>
</section>
-</section>
-<section>
- <h2 id="Bug_Fixing_Steps">Bug Fixing Steps</h2>
- <p>For all developers who are willing to contributing to Apache Helix for
fixing bugs, please following the steps we decribed below.</p>
- <ul>
- <li>If there is a github issue, assign that ticket to you if you are
committer. For contributors, you can leave a comment to let other committers to
assign that issue to you. If there is no issue in github, create an issue for
that.</li>
- <li>Working on the bug fixing in your forked repo.</li>
- <li>Submit PR based on our <a class="externalLink"
href="https://github.com/apache/helix/wiki/Pull-Request-Description-Template";>template</a></li>
- <li>Address all review comments and follow <a class="externalLink"
href="https://github.com/apache/helix/wiki/Pull-Request-Merge-Steps";>merge
steps</a></li>
- </ul>
-</section>
-<section>
- <h2 id="Relevant_Work">Relevant Work</h2>
- <p>When you work on bug fixing and you found other things need to be done,
feel free to create issues and leave <b>TODO</b> comments in the code to avoid
make the PR larger and larger.</p>
</section>
</div>
</div>
