lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-java Wiki] Update of "HowToContribute" by DavidSmiley
Date Wed, 27 Jul 2016 14:11:08 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.

The "HowToContribute" page has been changed by DavidSmiley:
https://wiki.apache.org/lucene-java/HowToContribute?action=diff&rev1=45&rev2=46

Comment:
Instructions on 'git diff' for feature branch

  In case your contribution fixes a bug, please create a new test case that fails before your
fix, to show the presence of the bug and ensure it never re-occurs. A test case showing the
presence of a bug is also a good contribution by itself.
  
  ==== Creating a patch ====
+ 
+ Before creating your patch, you may want to get 'master' up to date with the latest from
upstream.  This will help avoid the possibility of others finding merge conflicts when applying
your patch.  This can be done with {{{git pull}}} if master is the current branch.
+ 
+ If your changes are in your git working tree (i.e. not committed to a branch), then do this:
+ 
   1. Check to see what files you have modified with: {{{git status}}}
   1. Add any new files with: {{{git add src/.../MyNewClass.java}}}
-  1. In order to create a patch, just type {{{git diff HEAD > LUCENE-NNNN.patch}}}
+  1. In order to create a patch, just type {{{git diff HEAD > LUCENE-NNNN.patch}}}.
  
+ If your changes are all committed to the current (feature) branch:
+ 
+  1. {{{git diff master... > LUCENE-NNNN.patch}}}
+ 
+ If some of your changes are committed to the current (feature) branch but you have working-copy
changes too:
+ 
+  1. {{{git diff `git merge-base master head` > LUCENE-NNNN.patch}}}
+ 
- This will report all modifications done on Lucene sources on your local disk and save them
into the ''LUCENE-NNNN.patch'' file.  Read the patch file.   Make sure it includes ONLY the
modifications required to fix a single issue.
+ This will save a diff into the ''LUCENE-NNNN.patch'' file.  Read the patch file.   Make
sure it includes ONLY the modifications required to fix a single issue.
  
  === Contributing your work ===
  Finally, patches should be attached to a bug report in [[http://issues.apache.org/jira/browse/LUCENE|Jira]].

Mime
View raw message