You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Description

This page to help anyone who want to involve and contribute to eagle project. Apache site have great documentation on how apache build the community and help the open source project. If one wants to know more detail on how apache works, he/she might want to check http://community.apache.org/.

Here in this page we just focus on a consistent dev process to keep the project run smoothly.

 

Dev Process

To contribute code to eagle is simple, just

  1. Fork one's own feature branch from eagle official github (https://github.com/apache/incubator-eagle/)
  2. Fix bug / Develop feature in the feature branch. One might have multiple
  3. After development is done, send a github pull request. Like https://github.com/apache/incubator-eagle/pull/19. NOTE: Please make sure the pull request title is in format of EAGLE-${ticket_number} ${ticket_title}。So that ASF bot could help sync the pull request comments to JIRA automatically.

  4. Committers will help to review the pull request, merge the patch of the pull request and push the merged code to apache/incubbator-eagle.

    This steps are like

    > git pull https://github.com/apache/incubator-eagle/ master # get latest
> wget https://patch-diff.githubusercontent.com/raw/apache/incubator-eagle/pull/19.patch && git apply 19.patch    # anyway you like to get the patch and apply
> # review the code; run the test; 
> git commit   # Commit with the commit MSG described below if everything looks good
> git push https://github.com/apache/incubator-eagle/ master # push to upstream
  5. Committer to close the JIRA ticket. (Pull request will be close automatically)

 

In step4, committers should follow an convention format to add appropriate commit message. The format is

EAGLE-${ticket_number} ${ticket_title}
${ticket_url}

Author: ${commiter}
Reviewer: ${reviewer}

Closes #${pr_number} from ${do_person}
  1. Author/Reviewer could be optional when the committer is the single reviewer.
  2. Unable to render Jira issues macro, execution error. will help build automatic tools to help the steps above.

 

Below diagram show a simple flow of above.

 

 

 

 

 

  • No labels