Author: lukaszlenart
Date: Tue Mar 18 07:07:15 2014
New Revision: 1578771
URL: http://svn.apache.org/r1578771
Log:
Updates section about contributing via GitHub
Modified:
struts/site/trunk/content/git-for-struts.html
struts/site/trunk/source/git-for-struts.md
Modified: struts/site/trunk/content/git-for-struts.html
URL:
http://svn.apache.org/viewvc/struts/site/trunk/content/git-for-struts.html?rev=1578771&r1=1578770&r2=1578771&view=diff
==============================================================================
--- struts/site/trunk/content/git-for-struts.html (original)
+++ struts/site/trunk/content/git-for-struts.html Tue Mar 18 07:07:15 2014
@@ -129,50 +129,44 @@
<p>Please remember that <code>master</code> branch cannot be modified directly
from now on!</p>
+<h2>Non-committers</h2>
+
<p>If you aren't a committer you must use this link below or mirror at
GitHub</p>
<div class="highlight"><pre><code class="text language-text"
data-lang="text">git clone git://git.apache.org/struts.git struts-copy
</code></pre></div>
<h2>Contributing with GitHub</h2>
-<p>If you would like to contribute using the GitHub tools you need to know we
can only
-accept your work if we have your <a
href="http://www.apache.org/licenses/icla.txt";>ICLA</a> on file.
-Please read the document carefully, sign and send it to us. Basically this
document
-protects you and the end users for legal problems. It allows the Apache
Software Foundation
-to use your code and distribute it.
-You should receive an email a few days after you submitted it and appear in
the
-<a href="http://people.apache.org/committer-index.html";>committer index</a> in
the section "unlisted CLAs".</p>
+<p>Using GitHub mirror is the simplest way to contribute to Apache Struts if
you are not a member
+of Struts Committers group.</p>
-<p>Once done, you can clone the <a
href="https://github.com/apache/struts";>Apache Struts mirror on GitHub</a>:</p>
-<div class="highlight"><pre><code class="text language-text"
data-lang="text">git clone [email protected]:apache/struts.git struts-mirror.git
-</code></pre></div>
-<p>Please create an issue on our <a
href="https://issues.apache.org/jira/browse/WW";>issue tracker</a>.
-You'll receive an issue number which you should use to create a working
branch (for example WW-4196).</p>
+<p>First you must have an account created at GitHub to be able perform the
next step. If you don't,
+go ahead and create one just right now! Please remember to setup
+<a href="https://help.github.com/articles/generating-ssh-keys";>SSH keys</a>
and test them!</p>
-<p>If you are sending a pull request, please send it to the Apache Struts
teams repo and not
-the official mirror. We cannot accept and close pull requests there which is
the reason
-we have an own account. You can find it here:</p>
+<p>When ready go to <a
href="https://github.com/apache/struts";>https://github.com/apache/struts</a>
and click <code>Fork</code> button
+in top right corner. This will fork Apache Struts repository and will create
your private (but public) repository
+with the source code.</p>
-<p>[https://github.com/apachestruts/struts]</p>
+<p>Next step is to clone your repo locally, information how to do this you
will find on right sidebar of your repo
+under <code>SSH clone URL</code> headline.</p>
-<p>Please send the pull request to "trunk".</p>
+<p>Now you are ready to work with Apache Struts code base. Perform your
changes, commit them and
+next push to GitHub! Remember: commit in Git is different than commit in
Subversion!</p>
-<p>It is of course possible to add us as upstream repo:</p>
-<div class="highlight"><pre><code class="text language-text"
data-lang="text">git remote add upstream [email protected]:apachestruts/struts
-</code></pre></div>
-<h2>Working with remote branches from GitHub</h2>
+<p>With your changes pushed to GitHub you can prepare a Pull Request (short:
PR). Go to Apache Struts
+mirror - <a
href="https://github.com/apache/struts";>https://github.com/apache/struts</a> -
then to
+<a href="https://github.com/apache/struts/pulls";>Pull request</a> and hit
+<a href="https://github.com/apache/struts/compare/";>New Pull Request</a>
button.</p>
+
+<p>If not already selected, click on <code>compare across forks.</code> Right
now you must select from the dropdowns on right
+your fork and branch to compare the differences with Apache Struts develop
branch.</p>
+
+<p>Finally hit <code>Create Pull Request</code> button and you are done!</p>
+
+<p>Unfortunately not yet. We (Apache Struts committers) can use PRs just for
review, we cannot accept your work
+directly, so you must fill a JIRA ticket and assign a file with patch to it.
But that bother about that right now -
+go and hack!</p>
-<p>You can add a remote branch from GitHub like this:</p>
-<div class="highlight"><pre><code class="text language-text"
data-lang="text">git remote add opensourceio [email protected]:opensourceio/struts
-</code></pre></div>
-<p>Pull changes with:</p>
-<div class="highlight"><pre><code class="text language-text"
data-lang="text">git pull opensourceio anotherbranch
-</code></pre></div>
-<p>When merge conflicts happen, these can be resolved using:</p>
-<div class="highlight"><pre><code class="text language-text"
data-lang="text">git mergetool
-</code></pre></div>
-<p>After the merge, you need to commit the changes to Apache Git with:</p>
-<div class="highlight"><pre><code class="text language-text"
data-lang="text">git commit
-</code></pre></div>
<h2>Further reading</h2>
<ul>
Modified: struts/site/trunk/source/git-for-struts.md
URL:
http://svn.apache.org/viewvc/struts/site/trunk/source/git-for-struts.md?rev=1578771&r1=1578770&r2=1578771&view=diff
==============================================================================
--- struts/site/trunk/source/git-for-struts.md (original)
+++ struts/site/trunk/source/git-for-struts.md Tue Mar 18 07:07:15 2014
@@ -26,56 +26,44 @@ and done!
Please remember that `master` branch cannot be modified directly from now on!
+## Non-committers
+
If you aren't a committer you must use this link below or mirror at GitHub
git clone git://git.apache.org/struts.git struts-copy
## Contributing with GitHub
-If you would like to contribute using the GitHub tools you need to know we can
only
-accept your work if we have your
[ICLA](http://www.apache.org/licenses/icla.txt) on file.
-Please read the document carefully, sign and send it to us. Basically this
document
-protects you and the end users for legal problems. It allows the Apache
Software Foundation
-to use your code and distribute it.
-You should receive an email a few days after you submitted it and appear in
the
-[committer index](http://people.apache.org/committer-index.html) in the
section "unlisted CLAs".
-
-Once done, you can clone the [Apache Struts mirror on
GitHub](https://github.com/apache/struts):
-
- git clone [email protected]:apache/struts.git struts-mirror.git
-
-Please create an issue on our [issue
tracker](https://issues.apache.org/jira/browse/WW).
-You'll receive an issue number which you should use to create a working branch
(for example WW-4196).
-
-If you are sending a pull request, please send it to the Apache Struts teams
repo and not
-the official mirror. We cannot accept and close pull requests there which is
the reason
-we have an own account. You can find it here:
-
-[https://github.com/apachestruts/struts]
-
-Please send the pull request to "trunk".
-
-It is of course possible to add us as upstream repo:
-
- git remote add upstream [email protected]:apachestruts/struts
-
-## Working with remote branches from GitHub
+Using GitHub mirror is the simplest way to contribute to Apache Struts if you
are not a member
+of Struts Committers group.
-You can add a remote branch from GitHub like this:
+First you must have an account created at GitHub to be able perform the next
step. If you don't,
+go ahead and create one just right now! Please remember to setup
+[SSH keys](https://help.github.com/articles/generating-ssh-keys) and test them!
- git remote add opensourceio [email protected]:opensourceio/struts
+When ready go to
[https://github.com/apache/struts](https://github.com/apache/struts) and click
`Fork` button
+in top right corner. This will fork Apache Struts repository and will create
your private (but public) repository
+with the source code.
-Pull changes with:
+Next step is to clone your repo locally, information how to do this you will
find on right sidebar of your repo
+under `SSH clone URL` headline.
- git pull opensourceio anotherbranch
+Now you are ready to work with Apache Struts code base. Perform your changes,
commit them and
+next push to GitHub! Remember: commit in Git is different than commit in
Subversion!
-When merge conflicts happen, these can be resolved using:
+With your changes pushed to GitHub you can prepare a Pull Request (short: PR).
Go to Apache Struts
+mirror - [https://github.com/apache/struts](https://github.com/apache/struts)
- then to
+[Pull request](https://github.com/apache/struts/pulls) and hit
+[New Pull Request](https://github.com/apache/struts/compare/) button.
- git mergetool
+If not already selected, click on `compare across forks.` Right now you must
select from the dropdowns on right
+your fork and branch to compare the differences with Apache Struts develop
branch.
-After the merge, you need to commit the changes to Apache Git with:
+Finally hit `Create Pull Request` button and you are done!
- git commit
+Unfortunately not yet. We (Apache Struts committers) can use PRs just for
review, we cannot accept your work
+directly, so you must fill a JIRA ticket and assign a file with patch to it.
But that bother about that right now -
+go and hack!
## Further reading
