Hi All,
I am new to Lucene and recently made a small contribution. While figuring
out the contributing process, I felt that the documentation may not be up
to date.
The repository home page <https://github.com/apache/lucene#contributing>
links to this HowToContribute cwiki
<https://cwiki.apache.org/confluence/display/LUCENE/HowToContribute>, which
says that we should upload a patch file with our changes to the relevant
JIRA. However, I observed that contributions could also be made via Github
pull requests that one could raise from a Lucene fork.
Is patch-upload-to-jira, the preferred method of accepting contributions?
Or is there some other documentation that I missed?
The way I understand it, it is easier to review and comment on a pull
request. Perhaps if a reviewer wants to run/benchmark the code change,
downloading and applying a patch file may be easier.
I can help update the documentation if we need to.
We can also include some minor details - like prefixing the PR name with
all caps "LUCENE-#JIRA:", and making an entry in the changes file (these
were things that I had missed). Also, if we make these changes, would we
want to continue using the cwiki page, or just add a contributing.md to the
main repo?
--
- Vigya
I am new to Lucene and recently made a small contribution. While figuring
out the contributing process, I felt that the documentation may not be up
to date.
The repository home page <https://github.com/apache/lucene#contributing>
links to this HowToContribute cwiki
<https://cwiki.apache.org/confluence/display/LUCENE/HowToContribute>, which
says that we should upload a patch file with our changes to the relevant
JIRA. However, I observed that contributions could also be made via Github
pull requests that one could raise from a Lucene fork.
Is patch-upload-to-jira, the preferred method of accepting contributions?
Or is there some other documentation that I missed?
The way I understand it, it is easier to review and comment on a pull
request. Perhaps if a reviewer wants to run/benchmark the code change,
downloading and applying a patch file may be easier.
I can help update the documentation if we need to.
We can also include some minor details - like prefixing the PR name with
all caps "LUCENE-#JIRA:", and making an entry in the changes file (these
were things that I had missed). Also, if we make these changes, would we
want to continue using the cwiki page, or just add a contributing.md to the
main repo?
--
- Vigya