LUCENE-10184: add CONTRIBUTING.md; reorganize README. #771
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
would anyone want to review this... i'll wait until tomorrow then merge it (if there are no objections). |
dweiss
reviewed
Mar 28, 2022
CONTRIBUTING.md
Outdated
|
|
||
| ### Unit tests | ||
|
|
||
| Please make sure that all unit tests succeed before constructing your patch: `./gradlew test`. |
There was a problem hiding this comment.
I think it'd be good to run check instead of just test. We have so many validation checks that just the test alone won't do.
There was a problem hiding this comment.
Changed this section to encourage to use "gradlew check".
https://github.com/mocobeta/lucene/blob/lucene-10184/CONTRIBUTING.md#checks
dweiss
reviewed
Mar 28, 2022
CONTRIBUTING.md
Outdated
|
|
||
| ### Precommit | ||
|
|
||
| Please run `./gradlew precommit` to identify problems that should be addressed before you contribute your changes. |
There was a problem hiding this comment.
Use "gradlew check" here. I'd be willing to phase out the non-convention "precommit" at some point.
There was a problem hiding this comment.
this section was removed.
dweiss
reviewed
Mar 28, 2022
mocobeta
commented
Mar 29, 2022
|
|
||
| Patches should be attached to an issue in Jira. | ||
|
|
||
| To enable automatic validation of Jira patches, switch the issue's status to "Patch Available" by clicking on the "Enable Patch Review" button near the top of the page. This will enqueue an ASF Jenkins job 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. Note that in order for a patch file to trigger validation, its name must conform to the naming rules outlined here: https://yetus.apache.org/documentation/in-progress/precommit-patchnames/ |
There was a problem hiding this comment.
note: I noticed the link to Yetus documentation is not available but couldn't find the moved page or alternative. I'm not sure what should we do on it, I'd defer the decision here.
dweiss
approved these changes
Mar 29, 2022
|
Merged. Thank you for your feedback. |
wjp719
added a commit
to wjp719/lucene
that referenced
this pull request
Apr 5, 2022
* main: LUCENE-10456: Implement Weight#count for MultiRangeQuery (apache#731) LUCENE-10484: Move CHANGES entry to 9.2. LUCENE-10484: Add support for concurrent facets random sampling (apache#765) LUCENE-10002: Replaces usages of FacetsCollector with FacetsCollectorManager (apache#764) LUCENE-10466: Move changelog entry to 9.2 LUCENE-10466: Ensure IndexSortSortedNumericDocValuesRangeQuery handles sort types besides LONG LUCENE-10498: don't count num hits nor accumulate scores unless necessary (apache#782) LUCENE-10184: mention of opening a Jira issue (apache#781) Update link to contribution guide Remove redundant index (apache#776) Implement method to bulk add all collection elements to a PriorityQueue (apache#770) LUCENE-10491: Fix correctness bug in TaxonomyFacetSumValueSource score providing (apache#775) Replace usages of search(Query, Collector) in CheckHits (apache#763) LUCENE-10002: Add FixedBitSetCollector and corresponding collector manager to test framework (apache#766) LUCENE-10475: Merge o.a.l.a.[ja|ko].util into o.a.l.a.[ja|ko].dict (apache#772) LUCENE-10184: add CONTRIBUTING.md; reorganize README. (apache#771) Add CHANGES entry for LUCENE-10325 LUCENE-10325: Add getTopDims functionality to Facets (apache#747)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CONTRIBUTING.md; this is based on https://cwiki.apache.org/confluence/display/lucene/HowToContributeBuilding with Gradlesection in the README to CONTRIBUTING.md.To see how it looks, you can check the preview https://github.com/mocobeta/lucene/tree/lucene-10184.