Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update contributing guide for GH issue (#11716)

This commit is contained in:
Tomoko Uchida 2022-08-25 04:06:09 +09:00 committed by GitHub
parent 1529606763
commit 53b1ce7504
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,4 +1,4 @@
### Description (or a Jira issue link if you have one) ### Description
<!-- <!--
If this is your first contribution to Lucene, please make sure you have reviewed the contribution guide. If this is your first contribution to Lucene, please make sure you have reviewed the contribution guide.

17
CONTRIBUTING.md
View File

@ -70,7 +70,7 @@ Feel free to share your findings (especially if your implementation performs bet
## Contributing your work ## Contributing your work
You have two options to contribute your work: you can either create a patch and attach it to an issue on [Jira](https://issues.apache.org/jira/browse/LUCENE), or open a pull request at https://github.com/apache/lucene - whichever works best for you. You can open a pull request at https://github.com/apache/lucene.
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. 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.
@ -80,14 +80,11 @@ Please refer to [GitHub's documentation](https://docs.github.com/en/pull-request
You should open a pull request against the `main` branch. Committers will backport it to the maintenance branches once the change is merged into `main` (as far as it is possible). You should open a pull request against the `main` branch. Committers will backport it to the maintenance branches once the change is merged into `main` (as far as it is possible).
You can open a pull request with or without Jira issue. If there is an associated Jira issue, the pull request title should start with the Jira issue number that your work is related to, this way your pull request will get automatically linked from the Jira issue.
### Creating a patch ### Creating a patch
Note that you do not need to create a patch if you already opened a pull request on GitHub. Note that you do not need to create a patch if you already opened a pull request.
Patches should be attached to an issue in [Apache Jira](https://issues.apache.org/jira/projects/LUCENE/issues/), so first you'll need to create an account for it (if you don't have one). Patches should be attached to an issue. Since GitHub does not accept attachments with extension `.patch`, please rename your patch file `XXX.patch` to `XXX.patch.txt` or something like that.
Please refer to [git diff documentation](https://git-scm.com/docs/git-diff) for information of how to create a patch. Please refer to [git diff documentation](https://git-scm.com/docs/git-diff) for information of how to create a patch.
@ -95,7 +92,7 @@ Before creating your patch, you may want to get 'main' up to date with the lates
### Add a CHANGES entry ### Add a CHANGES entry
You may want to add a CHANGES entry to [CHANGES.txt](./lucene/CHANGES.txt). A CHANGES entry should start with the Jira issue key `LUCENE-XXXXX` or pull request number `GITHUB#XXX` that is followed by the description of the change and contributors' name. Please see the existing entries for reference. You may want to add a CHANGES entry to [CHANGES.txt](./lucene/CHANGES.txt). A CHANGES entry should start with the issue or pull request number `GITHUB#XXX` that is followed by the description of the change and contributors' name. Please see the existing entries for reference.
## Stay involved ## Stay involved
@ -105,16 +102,14 @@ Please keep discussions about Lucene on list so that everyone benefits. Emailing
## Getting your feet wet: where to begin? ## Getting your feet wet: where to begin?
New to Lucene? Want to find JIRA issues that you can work on without taking on the whole world? New to Lucene? Want to find issues that you can work on without taking on the whole world?
The Lucene/Solr developers use the "newdev" label to mark issues that developers new to Lucene might be interested in working on. The rough criteria used to make this selection are: The rough criteria for picking your first issues are:
- Nobody has done any work on the issue yet. - Nobody has done any work on the issue yet.
- The issue is likely not controversial. - The issue is likely not controversial.
- The issue is likely self-contained with limited scope. - The issue is likely self-contained with limited scope.
To see a list of open Lucene issues with the newdev label, look at this link [http://s.apache.org/newdevlucenesolr](https://issues.apache.org/jira/browse/SOLR-15591?jql=(project%3DLUCENE)%20AND%20resolution%3DUnresolved%20AND%20labels%3Dnewdev).
## Developer tips ## Developer tips
For more contribution guidelines and tips, see [DeveloperTips](https://cwiki.apache.org/confluence/display/LUCENE/DeveloperTips). For more contribution guidelines and tips, see [DeveloperTips](https://cwiki.apache.org/confluence/display/LUCENE/DeveloperTips).