unstick r1865401

Revision 1865401

Date:
2019/08/18 17:12:58
Author:
isudana
Revision Log:
Update site to include information on Github
Files:

Legend:

 
Added
 
Removed
 
Modified
  • synapse/site/dev/developer-guide.html

     
    113 113 <ul>
    114 114
    115 115 <li>
    116 <a href="#subversion">Interacting with the Code Base Using Subversion</a>
    116 <a href="#git">Interacting with the Code Base Using Git</a>
    117 117
    118 118 <ul>
    119 119
     
    149 149 </li>
    150 150 </ul>
    151 151 </div>
    152 <a name="subversion"></a>
    153 <div class="section" id="subversion">
    154 <h2><a name="Interacting_with_the_Code_Base_Using_Subversion"></a>Interacting with the Code Base Using Subversion</h2>
    152 <a name="git"></a>
    153 <div class="section" id="git">
    154 <h2><a name="Interacting_with_the_Code_Base_Using_Git"></a>Interacting with the Code Base Using Git</h2>
    155 155
    156 156 <p>
    157 Synapse code base is maintained in a Subversion repository. Therefore, anyone willing
    158 to go through the Synapse source code in the development trunk and make contributions
    159 should use a Subversion client to interact with the Synapse code base. To learn more
    160 about using Subversion or to download the latest client distributions, please visit
    161 the <a class="externalLink" href="http://subversion.apache.org">Apache Subversion project website</a>.
    162 Developers on Unix/Linux based systems may use the command line based SVN client,
    163 while the developers on Windows platform can use an appropriate client application
    164 like <a class="externalLink" href="http://tortoisesvn.net/">TortoiseSVN</a>.
    165 </p>
    157 Synapse code base is maintained in a Github repository.
    158 Therefore, anyone willing to go through the Synapse source code and make contributions should use a Git client
    159 to interact with the Synapse code base.
    160 </p>
    166 161
    167 162 <p>
    168 163 Some useful information on using the Apache Software Foundation's source code
     
    174 169 <h3><a name="Checking_Out_the_Source"></a>Checking Out the Source</h3>
    175 170
    176 171 <p>
    177 Synapse development trunk is where all the latest development work takes place.
    178 This is located at
    179 <a class="externalLink" href="http://svn.apache.org/repos/asf/synapse/trunk/java/">http://svn.apache.org/repos/asf/synapse/trunk/java/</a>.
    180 Any developer with a Subversion client should be able to checkout the latest
    181 source from this SVN location but only Synapse committers are allowed to actually
    182 commit source code. Synapse committers should access the above SVN location over
    183 HTTPS and provide the ASF committer credentials to checkout and commit source
    184 code. Please refer the <a href="../source-repository.html">source repository guide</a>
    185 for more details on checking out the source code from the above repository.
    186 </p>
    172
    173 Master branch of the Synapse Github repository is where all the latest development work takes place.
    174 This is located at
    175 <a class="externalLink" href="https://github.com/apache/synapse/tree/master">
    176 https://github.com/apache/synapse/tree/master</a>.
    177 Any developer with a Git client should be able to checkout the latest source from this location,
    178 but only Synapse committers are allowed to merge Pull Requests to the source code.
    179 Please see the <a href="#contrib">Making Contributions</a> section for more information on how developers can make
    180 an contribution.
    181 </p>
    187 182
    188 <p>
    189 Once you have checked out the source code, you can update your working copy by
    190 running the 'svn update' command. This will checkout the modifications since the
    191 last checkout/update and bring your local working copy to the latest revision.
    192 </p>
    193
    194 <p>
    195 If you want to browse the source code of an older release of Synapse or want
    196 to implement a patch for a past release, you may checkout the relevant source
    197 tree from one of the available SVN
    198 <a class="externalLink" href="http://svn.apache.org/repos/asf/synapse/tags/">tags</a>.
    199 </p>
    200 183 </div>
    201 184 </div>
    202 185 <a name="maven"></a>
     
    385 368 <h2><a name="Making_Contributions"></a>Making Contributions</h2>
    386 369
    387 370 <p>
    388 If you have implemented a new feature, fixed some bug in the code or written a new
    389 sample, we'll be more than happy to review it and include it in the Synapse code
    390 base for everyone's benefit. If you are interested in contributing your work to Synapse,
    391 please create an issue in the JIRA system first. Then you can attach your workings to
    392 the JIRA issue as a patch.
    393 </p>
    371 If you have implemented a new feature, fixed some bug in the code or written a new sample,
    372 we'll be more than happy to review it and include it in the Synapse code base for everyone's benefit.
    373 If you are interested in contributing your work to Synapse,
    374 please create an issue in the JIRA system first.
    375 Then you can send a Github Pull Request contains the fixes to the Synapse Github master branch.
    376
    377 </p>
    394 378
    395 379 <p>
    396 To create a patch file out of your work simply run the 'svn diff' command.
    397 </p>
    398
    399 <div class="command">svn diff &gt; FixForIssue123.patch</div>
    400
    380 To create a pull request follow the following approach,
    381
    382 <ul><li>Fork the Synapse Github repositoty</li></ul>
    383 <ul><li>Take a checkout of your forked Github repository into local file system</li></ul>
    384 <ul><li>Switch to a new branch</li></ul>
    385 <ul><li>Do required code fixes</li></ul>
    386 <ul><li>Commit the fixes and push them together with the new branch to the remote origin Github repository</li></ul>
    387 <ul><li>Using the Github web UI, create a Pull Request from the branch that contains fixes of forked Github
    388 repository to master branch of Synapse Github repository</li></ul>
    389 </p>
    401 390 <p>
    402 If you added any new files as a part of your work you should first run the 'svn add'
    403 command on them before creating the patch file. Otherwise they won't be included
    404 in the generated patch.
    405 </p>
    406
    407 <p>
    408 Once the patch file has been created, attach it to the relevant JIRA issue and make
    409 sure to grant the ASF permission to use your patch in ASF development activities.
    410 One of the committers will review your work and provide feedback through the JIRA. If
    411 all is well, the patch will eventually go into the Synapse development trunk.
    412 </p>
    391 Once the Pull Request has been created, put a comment to the relevant JIRA.
    392 One of the committers will review your work and provide feedback through the Github Pull Request itself.
    393 If all is well, the Pull Request will eventually get merged into the Synapse development branch.
    394 </p>
    395
    396 <p>Same process applies even for committers.</p>
    397 <p>It is recommended to submit a Pull Request for review rather
    398 than directly committing to the code base.</p>
    399 </p>
    400
    413 401 </div>
    414 402
    415 403
  • synapse/site/dev/release-process.html

     
    92 92 <p>
    93 93 We follow the standard <a class="externalLink" href="http://www.apache.org/dev/release-publishing.html">ASF release process</a>.
    94 94 One of the committers would volunteer to play the release manager role for a given
    95 release. A few days will be spent on stabilizing the Synapse development trunk,
    95 release. A few days will be spent on stabilizing the Synapse development branch,
    96 96 improving its documentation and test coverage. When the code base is in a satisfactory
    97 state a release branch would be created under
    98 <a class="externalLink" href="https://svn.apache.org/repos/asf/synapse/branches">https://svn.apache.org/repos/asf/synapse/branches</a>.
    99 .
    97 state a release branch would be created.
    100 98 </p>
    101 99
    102 100 <p>
  • synapse/site/source-repository.html

     
    85 85 </div>
    86 86 <div id="bodyColumn" class="span10" >
    87 87 <div class="section">
    88 <h2><a name="Overview"></a>Overview</h2><a name="Overview"></a>
    89 <p>This project uses <a class="externalLink" href="http://subversion.apache.org/">Subversion</a> to manage its source code. Instructions on Subversion use can be found at <a class="externalLink" href="http://svnbook.red-bean.com/">http://svnbook.red-bean.com/</a>.</p></div>
    90 <div class="section">
    91 <h2><a name="Web_Access"></a>Web Access</h2><a name="Web_Access"></a>
    92 <p>The following is a link to the online source repository.</p>
    93 <div class="source"><pre class="prettyprint"><a class="externalLink" href="http://svn.apache.org/viewvc/synapse/trunk/java">http://svn.apache.org/viewvc/synapse/trunk/java</a></pre></div></div>
    94 <div class="section">
    95 <h2><a name="Anonymous_access"></a>Anonymous access</h2><a name="Anonymous_access"></a>
    96 <p>The source can be checked out anonymously from SVN with this command:</p>
    97 <div class="source"><pre class="prettyprint">$ svn checkout http://svn.apache.org/repos/asf/synapse/trunk/java synapse</pre></div></div>
    98 <div class="section">
    99 <h2><a name="Developer_access"></a>Developer access</h2><a name="Developer_access"></a>
    100 <p>Everyone can access the Subversion repository via HTTP, but Committers must checkout the Subversion repository via HTTPS.</p>
    101 <div class="source"><pre class="prettyprint">$ svn checkout https://svn.apache.org/repos/asf/synapse/trunk/java synapse</pre></div>
    102 <p>To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password)</p>
    103 <div class="source"><pre class="prettyprint">$ svn commit --username your-username -m &quot;A message&quot;</pre></div></div>
    104 <div class="section">
    105 <h2><a name="Access_from_behind_a_firewall"></a>Access from behind a firewall</h2><a name="Access_from_behind_a_firewall"></a>
    106 <p>For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion repository, you can try to access it via the developer connection:</p>
    107 <div class="source"><pre class="prettyprint">$ svn checkout https://svn.apache.org/repos/asf/synapse/trunk/java synapse</pre></div></div>
    108 <div class="section">
    109 <h2><a name="Access_through_a_proxy"></a>Access through a proxy</h2><a name="Access_through_a_proxy"></a>
    110 <p>The Subversion client can go through a proxy, if you configure it to do so. First, edit your &quot;servers&quot; configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory &quot;~/.subversion&quot;. On Windows it is in &quot;%APPDATA%\Subversion&quot;. (Try &quot;echo %APPDATA%&quot;, note this is a hidden directory.)</p>
    111 <p>There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created.</p>
    112 <p>Example: Edit the 'servers' file and add something like:</p>
    113 <div class="source"><pre class="prettyprint">[global]
    114 http-proxy-host = your.proxy.name
    115 http-proxy-port = 3128
    116 </pre></div></div>
    88 <h2><a name="Source Repository"></a>Source Repository</h2><a name="Source Repository"></a>
    89
    90
    91 <p> This project uses Github to manage its source code.</p>
    92 <p>
    93 Master branch of the Synapse Github repository is where all the latest development work takes place.</p>
    94 <p> This is located at</p>
    95
    96 <a class="externalLink" href="https://github.com/apache/synapse/tree/master">https://github.com/apache/synapse/tree/master</a>
    97
    98 </div>
    117 99 </div>
    118 100 </div>
    119 101 </div>