| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd"> | |
| <!-- ====================================================================== --> | |
| <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! --> | |
| <!-- ====================================================================== --> | |
| <html> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> | |
| <style type="text/css">@import "stylesheets/base.css";</style> | |
| <meta name="author" value=" Apache UIMA Documentation Team"> | |
| <meta name="email" value="dev@uima.apache.org"> | |
| <title>Apache UIMA - GIT work process</title> | |
| <!-- Begin Cookie Consent plugin by Silktide - https://silktide.com/cookieconsent --> | |
| <!-- Commented out because implied consent is not compatible with GDPR --> | |
| <!-- | |
| <script type="text/javascript"> | |
| window.cookieconsent_options = {"message":"This website uses cookies to ensure you get the best experience on our website","dismiss":"Got it!","learnMore":"More info","link":"https://uima.apache.org/privacy-policy.html","theme":"dark-bottom"}; | |
| </script> | |
| <script type="text/javascript" src="/cookieconsent2/cookieconsent.min.js"></script> | |
| --> | |
| <!-- End Cookie Consent plugin --> | |
| <!-- Begin Google Analytics --> | |
| <!-- Commented out because GA requires consent according to GDPR --> | |
| <!-- | |
| <script> | |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ | |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), | |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) | |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); | |
| ga('create', 'UA-70846351-1', 'auto'); | |
| ga('set', 'anonymizeIp', true); | |
| ga('send', 'pageview'); | |
| </script> | |
| --> | |
| <!-- End Google Analytics --> | |
| </head> | |
| <body> | |
| <div class="topLogos"> | |
| <table border="0" width="100%" cellspacing="0"> | |
| <!-- TOP IMAGE --> | |
| <tr> | |
| <td align='LEFT'> | |
| <a href="index.html"> | |
| <img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/> | |
| </a> | |
| </td> | |
| <td align='CENTER'> | |
| <div class="pageBanner">GIT work process</div> | |
| </td> | |
| <td align='RIGHT'> | |
| <a href="https://www.apache.org"> | |
| <img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/> | |
| </a> | |
| </td> | |
| </tr> | |
| </table> | |
| <hr noshade="" size="1"/> | |
| </div> | |
| <table border="0" width="100%" cellspacing="4"> | |
| <tr> | |
| <td align='RIGHT' colspan="2"> | |
| <form method="get" action="https://www.google.com/search"> | |
| Search the site | |
| <input type="text" name="q" size="25" maxlength="255" value="" /> | |
| <input type="hidden" name="sitesearch" value="https://uima.apache.org/" /> | |
| <input name="Search" value="Search Site" type="submit"/> | |
| </form> | |
| </td> | |
| </tr> | |
| <tr> <!-- LEFT SIDE NAVIGATION --> | |
| <td width="20%" valign="top"> | |
| <!-- regular menu --> | |
| <div class="navBar"> | |
| <br/> | |
| <div class="navBarItem"> <div class="navPartHeading">General</div> | |
| </div> | |
| <div class="navBar"> | |
| <div class="navBarItem"> <a href="./index.html">Home</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./downloads.cgi">Downloads</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./documentation.html">Documentation</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./news.html">News</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./publications.html">Publications</a> | |
| </div> | |
| <br style="line-height: .5em"/> | |
| <div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a> | |
| </div> | |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a> | |
| </div> | |
| <br style="line-height: .5em"/> | |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a> | |
| </div> | |
| </div> | |
| <br/> | |
| <div class="navBarItem"> <div class="navPartHeading">Community</div> | |
| </div> | |
| <div class="navBar"> | |
| <div class="navBarItem"> <a href="./get-involved.html">Get Involved</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./faq.html">FAQ</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a> | |
| </div> | |
| </div> | |
| <br/> | |
| <div class="navBarItem"> <div class="navPartHeading">Components & Tools</div> | |
| </div> | |
| <div class="navBar"> | |
| <div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a> | |
| </div> | |
| <div class="navBarItem"> <a href="https://github.com/apache/uima-uimafit" target="_blank" rel="noopener">uimaFIT <img src="images/offsitelink.png"/></a> | |
| </div> | |
| <div class="navBarItem"> <a href="./external-resources.html">External Resources</a> | |
| </div> | |
| </div> | |
| <br/> | |
| <div class="navBarItem"> <div class="navPartHeading">Development</div> | |
| </div> | |
| <div class="navBar"> | |
| <div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./building-uima.html">Building from Source</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./svn.html">Source Code</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a> | |
| </div> | |
| <div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a> | |
| </div> | |
| <div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./git.html">GIT</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./team-list.html">Project Team</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./maven-design.html">Maven Use</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a> | |
| </div> | |
| </div> | |
| <br/> | |
| <div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div> | |
| </div> | |
| <div class="navBar"> | |
| <div class="navBarItem"> <a href="./coling14.html">COLING 2014</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./iks09.html">IKS 2009</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a> | |
| </div> | |
| <div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a> | |
| </div> | |
| </div> | |
| <br/> | |
| <div class="navBarItem"> <div class="navPartHeading">ASF</div> | |
| </div> | |
| <div class="navBar"> | |
| <div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a> | |
| </div> | |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a> | |
| </div> | |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a> | |
| </div> | |
| <div class="navBarItem"> <a href="./security_report">Security</a> | |
| </div> | |
| </div> | |
| </div> | |
| </td> | |
| <td width="80%" align="left" valign="top"> | |
| <div class="sectionTable"> | |
| <table class="sectionTable"> | |
| <tr><td> | |
| <a name="Git Work Process"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Git Work Process</h1></a> | |
| </td></tr> | |
| <tr><td> | |
| <blockquote class="sectionBody"> | |
| <p>This describes the normal way you work on a UIMA project as a contributor. | |
| </p> | |
| <h2>Preliminaries</h2> | |
| <p>You may be working on a feature or a bug fix. These are similar, except typically, features | |
| may be worked on over a longer period.</p> | |
| <p>A preliminary step: Sign up for a github.com account, if you don't already have one.</p> | |
| <h2>Fork the repo (if not a committer)</h2> | |
| <p>The first step is to fork the project on githhub. To do this, point your browser to the repository, | |
| and press the fork button. | |
| </p> | |
| <img src="./images/git/fork.png" alt="fork button" /> | |
| <p>This will fork (create a writable-by-you) copy of the repo, in your personal github account. | |
| </p> | |
| <p>If you are a committer, skip ahead to Make a branch. You can make the branch on the github.com website by | |
| first switching (if needed) the branch you'll be branching from (e.g. master, or master-v2, etc.), and then | |
| typing the name of the new branch in the Branch pulldown.</p> | |
| <h2>Clone the fork</h2> | |
| <p>Next, clone the fork to your local development machine. After the above step, your browser should | |
| be positioned at the forked repository. Click the green clone-or-download button near the top, | |
| and proceed to clone this repo. For example you could copy the link starting with "https://github.com..." | |
| to the clipboard, and then open a command line and CD to a directory where you keep your clones, and then | |
| use the git command <code>git clone https://github.com...</code> (paste the address into the command). | |
| </p> | |
| <h2>Make a branch</h2> | |
| <p>Next, make a branch where you'll do the work. Name the branch with the name of the Jira issue ticket this work | |
| is being done for; e.g. "UIMA-6455", or some other name of your choosing. Then switch the checkout to that | |
| new branch. The git command to do these two steps in one command is | |
| <code>git checkout -b the-new-branch-name</code></p> | |
| <p>The reason to work in a branch is to keep changes related to one issue separate from other | |
| work. If you were also not working on a fork, but on the main project, this practice would also separate the | |
| changes from the "production-ready" master branch, until things have been reviewed and tested.</p> | |
| <h2>Make your changes</h2> | |
| <p>Now make your changes. You can commit the changes as you desire, and push them to your forked copy.</p> | |
| <h2>Commit / push your changes</h2> | |
| <p>When you're ready to have others look at the changes and give feedback, and eventually accept them into the | |
| official project, commit the changes and push them to your fork (if not already done). | |
| </p> | |
| <h2>Open a pull request</h2> | |
| <p>Then open a pull request. If you don't see a Create pull request | |
| <img src="./images/git/create-pull-request.png" alt="Create pull request button" /> button, click on the Pull requests tab | |
| <img src="./images/git/pull-request-tab.png" alt="pull requests tab" /> and on the next screen press the | |
| New pull request button <img src="./images/git/new-pull-request.png" alt="New pull request button" />.</p> | |
| <p>Follow the instructions to complete and submit the pull request. | |
| <h2>Iterate to resolve any issues</h2> | |
| At that point, the reviewers/committers on the project | |
| will take a look at your proposed changes, and perhaps give feedback. Work with them to resolve any | |
| issues. When the change is OK, a committer will pull this change into the master branch.</p> | |
| </blockquote> | |
| </p> | |
| </td></tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <!-- FOOTER --> | |
| <tr><td colspan="2"> | |
| <hr noshade="" size="1"/> | |
| </td></tr> | |
| <tr><td colspan="2"> | |
| <table class="pageFooter"> | |
| <tr> | |
| <td><a href="index.html">Home</a></td> | |
| <td><a href="privacy-policy.html">Privacy Policy</a></td> | |
| <td style="font-size:75%"> | |
| Copyright © 2006-2024, The Apache Software Foundation.<br/> | |
| Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/> | |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. | |
| </td> | |
| <td><a href="mailto:dev@uima.apache.org">Contact us</a></td> | |
| </tr> | |
| </table> | |
| </td></tr> | |
| </table> | |
| </body> | |
| </html> | |