You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2018/03/21 22:59:07 UTC

[Lucene-java Wiki] Update of "HowToContribute" by SteveRowe

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 SteveRowe:
https://wiki.apache.org/lucene-java/HowToContribute?action=diff&rev1=46&rev2=47

Comment:
Added 'ant precommit' section.  Added auto Jira patch validation info to the 'Contributing your work' section.

  
  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.
  
+ ==== ant precommit ====
+ 
+ Please run {{{ant precommit}}} to identify problems that should be addressed before you contribute your changes.
+ 
  ==== 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.
@@ -26, +30 @@

  
   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:
  
@@ -36, +40 @@

  
   1. {{{git diff `git merge-base master head` > LUCENE-NNNN.patch}}}
  
- 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.
+ 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]].
+ Patches should be attached to an issue in [[https://issues.apache.org/jira/browse/LUCENE|Jira]]
+ 
+ To enable automatic validation of Jira patches, switch the issue's state to "Patch Available" by clicking on the "Submit Patch" button near the top of the page.  This will trigger ASF Jenkins job [[https://builds.apache.org/job/PreCommit-LUCENE-Build/|PreCommit-LUCENE-Build]] to run various quality checks on the patch and post a validation report as a comment (by "Lucene/Solr QA") on the issue.  Expect a delay of 12 hours or so before the patch validation job actually runs.
  
  Please be patient.  Committers are busy people too.  If no one responds to your patch after a few days, please make friendly reminders.  Please incorporate others' suggestions into into your patch if you think they're reasonable.  Finally, remember that even a patch that is not committed is useful to the community.