You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@solr.apache.org by Eric Pugh <ep...@opensourceconnections.com> on 2022/02/16 07:22:30 UTC
Define what requires a JIRA and an entry in CHANGES.txt?
Hi all! Do we have a written definition of what requires a JIRA and/or an entry in CHANGES.txt? Something that could go in our developer docs?
Is there a consensus on this? For example, changes to documentation typically have NOT gone into the CHANGES.txt file. It appears that some refactoring don’t need a JIRA issue as well.
Thoughts on this?
Eric
_______________________
Eric Pugh | Founder & CEO | OpenSource Connections, LLC | 434.466.1467 | http://www.opensourceconnections.com <http://www.opensourceconnections.com/> | My Free/Busy <http://tinyurl.com/eric-cal>
Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
This e-mail and all contents, including attachments, is considered to be Company Confidential unless explicitly stated otherwise, regardless of whether attachments are marked as such.
Re: Define what requires a JIRA and an entry in CHANGES.txt?
Posted by David Smiley <ds...@apache.org>.
This has been discussed and documented before:
https://cwiki.apache.org/confluence/display/SOLR/Commit+Process+Guidelines#CommitProcessGuidelines-UpdatingCHANGES.txt
In general I push for us to not waste our time on busy-work like this, not
to mention hassling everyone else in perpetuity who reads the CHANGES.txt
to read that some test doesn't need a dependency it once needed ;-).
Fundamentally ask yourself *who cares*? Are there user perceivable
consequences? Are there non-trivial risks?
~ David Smiley
Apache Lucene/Solr Search Developer
http://www.linkedin.com/in/davidwsmiley
On Wed, Feb 16, 2022 at 2:22 AM Eric Pugh <ep...@opensourceconnections.com>
wrote:
> Hi all! Do we have a written definition of what requires a JIRA and/or
> an entry in CHANGES.txt? Something that could go in our developer docs?
>
> Is there a consensus on this? For example, changes to documentation
> typically have NOT gone into the CHANGES.txt file. It appears that some
> refactoring don’t need a JIRA issue as well.
>
> Thoughts on this?
>
>
> Eric
>
> _______________________
> *Eric Pugh **| *Founder & CEO | OpenSource Connections, LLC | 434.466.1467
> | http://www.opensourceconnections.com | My Free/Busy
> <http://tinyurl.com/eric-cal>
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed
> <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
> This e-mail and all contents, including attachments, is considered to be
> Company Confidential unless explicitly stated otherwise, regardless
> of whether attachments are marked as such.
>
>
Re: Define what requires a JIRA and an entry in CHANGES.txt?
Posted by Timothy Potter <th...@gmail.com>.
The approach I've always used is: any change to the codebase needs a
JIRA. Any change a user would care about (in the most liberal sense)
needs a changes.txt entry. Refactoring that doesn't impact APIs (such
as changes to tests) doesn't need a changes.txt entry. In general it's
rare for me to make a change to Solr and not put in changes.txt but I
also don't do as much refactoring of internals as Mike does ;-)
On Wed, Feb 16, 2022 at 11:07 AM Eric Pugh
<ep...@opensourceconnections.com> wrote:
>
> It wasn’t just your PR, there has been a couple times when I was kind of on the fence and not sure.
>
> On Feb 16, 2022, at 6:45 PM, Mike Drob <md...@mdrob.com> wrote:
>
> If this is about my PR https://github.com/apache/solr/pull/641 then I'm happy to add a JIRA for it. I initially said that I wasn't sure if it was big enough to warrant an issue because it was almost entirely test changes, and even then not really functional changes. But it's 200 lines of difference, so that's probably well past the "minor change" territory.
>
> I don't think there is a written consensus on this, but it's come up a few times on the mailing list before. I don't think we ever reached consensus there either.
>
> Mike
>
> On Wed, Feb 16, 2022 at 2:09 AM Ishan Chattopadhyaya <ic...@gmail.com> wrote:
>>
>> IMO, any code change should have a JIRA and CHANGES.txt. Substantial ref guide changes should have a JIRA.
>> Refactoring should definitely get a JIRA, I'll be surprised if any refactoring has happened without a JIRA.
>>
>> On Wed, Feb 16, 2022 at 12:52 PM Eric Pugh <ep...@opensourceconnections.com> wrote:
>>>
>>> Hi all! Do we have a written definition of what requires a JIRA and/or an entry in CHANGES.txt? Something that could go in our developer docs?
>>>
>>> Is there a consensus on this? For example, changes to documentation typically have NOT gone into the CHANGES.txt file. It appears that some refactoring don’t need a JIRA issue as well.
>>>
>>> Thoughts on this?
>>>
>>>
>>> Eric
>>>
>>> _______________________
>>> Eric Pugh | Founder & CEO | OpenSource Connections, LLC | 434.466.1467 | http://www.opensourceconnections.com | My Free/Busy
>>> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed
>>> This e-mail and all contents, including attachments, is considered to be Company Confidential unless explicitly stated otherwise, regardless of whether attachments are marked as such.
>>>
>
> _______________________
> Eric Pugh | Founder & CEO | OpenSource Connections, LLC | 434.466.1467 | http://www.opensourceconnections.com | My Free/Busy
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed
> This e-mail and all contents, including attachments, is considered to be Company Confidential unless explicitly stated otherwise, regardless of whether attachments are marked as such.
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
For additional commands, e-mail: dev-help@solr.apache.org
Re: Define what requires a JIRA and an entry in CHANGES.txt?
Posted by Anshum Gupta <an...@anshumgupta.net>.
As I've been going through the CHANGES.txt entries for the 9.0 release
notes, here's what I have been feeling:
- CHANGES entries are mostly for users who're trying to understand what
changes they'd be picking up in a specific release. We link it from the
release notes too.
- Anything that requires reasonable effort or tracking should have a JIRA.
I'd leave out minor typos etc. in this case and have a JIRA for almost
everything else.
Of course, there are exceptions to all of it :)
On Wed, Feb 16, 2022 at 10:07 AM Eric Pugh <ep...@opensourceconnections.com>
wrote:
> It wasn’t just your PR, there has been a couple times when I was kind of
> on the fence and not sure.
>
> On Feb 16, 2022, at 6:45 PM, Mike Drob <md...@mdrob.com> wrote:
>
> If this is about my PR https://github.com/apache/solr/pull/641 then I'm
> happy to add a JIRA for it. I initially said that I wasn't sure if it was
> big enough to warrant an issue because it was almost entirely test changes,
> and even then not really functional changes. But it's 200 lines of
> difference, so that's probably well past the "minor change" territory.
>
> I don't think there is a written consensus on this, but it's come up a few
> times on the mailing list before. I don't think we ever reached
> consensus there either.
>
> Mike
>
> On Wed, Feb 16, 2022 at 2:09 AM Ishan Chattopadhyaya <
> ichattopadhyaya@gmail.com> wrote:
>
>> IMO, any code change should have a JIRA and CHANGES.txt. Substantial ref
>> guide changes should have a JIRA.
>> Refactoring should definitely get a JIRA, I'll be surprised if any
>> refactoring has happened without a JIRA.
>>
>> On Wed, Feb 16, 2022 at 12:52 PM Eric Pugh <
>> epugh@opensourceconnections.com> wrote:
>>
>>> Hi all! Do we have a written definition of what requires a JIRA
>>> and/or an entry in CHANGES.txt? Something that could go in our developer
>>> docs?
>>>
>>> Is there a consensus on this? For example, changes to documentation
>>> typically have NOT gone into the CHANGES.txt file. It appears that some
>>> refactoring don’t need a JIRA issue as well.
>>>
>>> Thoughts on this?
>>>
>>>
>>> Eric
>>>
>>> _______________________
>>> *Eric Pugh **| *Founder & CEO | OpenSource Connections, LLC | 434.466.1467
>>> | http://www.opensourceconnections.com | My Free/Busy
>>> <http://tinyurl.com/eric-cal>
>>> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed
>>> <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
>>> This e-mail and all contents, including attachments, is considered to be
>>> Company Confidential unless explicitly stated otherwise, regardless
>>> of whether attachments are marked as such.
>>>
>>>
> _______________________
> *Eric Pugh **| *Founder & CEO | OpenSource Connections, LLC | 434.466.1467
> | http://www.opensourceconnections.com | My Free/Busy
> <http://tinyurl.com/eric-cal>
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed
> <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
> This e-mail and all contents, including attachments, is considered to be
> Company Confidential unless explicitly stated otherwise, regardless
> of whether attachments are marked as such.
>
>
--
Anshum Gupta
Re: Define what requires a JIRA and an entry in CHANGES.txt?
Posted by Eric Pugh <ep...@opensourceconnections.com>.
It wasn’t just your PR, there has been a couple times when I was kind of on the fence and not sure.
> On Feb 16, 2022, at 6:45 PM, Mike Drob <md...@mdrob.com> wrote:
>
> If this is about my PR https://github.com/apache/solr/pull/641 <https://github.com/apache/solr/pull/641> then I'm happy to add a JIRA for it. I initially said that I wasn't sure if it was big enough to warrant an issue because it was almost entirely test changes, and even then not really functional changes. But it's 200 lines of difference, so that's probably well past the "minor change" territory.
>
> I don't think there is a written consensus on this, but it's come up a few times on the mailing list before. I don't think we ever reached consensus there either.
>
> Mike
>
> On Wed, Feb 16, 2022 at 2:09 AM Ishan Chattopadhyaya <ichattopadhyaya@gmail.com <ma...@gmail.com>> wrote:
> IMO, any code change should have a JIRA and CHANGES.txt. Substantial ref guide changes should have a JIRA.
> Refactoring should definitely get a JIRA, I'll be surprised if any refactoring has happened without a JIRA.
>
> On Wed, Feb 16, 2022 at 12:52 PM Eric Pugh <epugh@opensourceconnections.com <ma...@opensourceconnections.com>> wrote:
> Hi all! Do we have a written definition of what requires a JIRA and/or an entry in CHANGES.txt? Something that could go in our developer docs?
>
> Is there a consensus on this? For example, changes to documentation typically have NOT gone into the CHANGES.txt file. It appears that some refactoring don’t need a JIRA issue as well.
>
> Thoughts on this?
>
>
> Eric
>
> _______________________
> Eric Pugh | Founder & CEO | OpenSource Connections, LLC | 434.466.1467 | http://www.opensourceconnections.com <http://www.opensourceconnections.com/> | My Free/Busy <http://tinyurl.com/eric-cal>
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
> This e-mail and all contents, including attachments, is considered to be Company Confidential unless explicitly stated otherwise, regardless of whether attachments are marked as such.
>
_______________________
Eric Pugh | Founder & CEO | OpenSource Connections, LLC | 434.466.1467 | http://www.opensourceconnections.com <http://www.opensourceconnections.com/> | My Free/Busy <http://tinyurl.com/eric-cal>
Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
This e-mail and all contents, including attachments, is considered to be Company Confidential unless explicitly stated otherwise, regardless of whether attachments are marked as such.
Re: Define what requires a JIRA and an entry in CHANGES.txt?
Posted by Mike Drob <md...@mdrob.com>.
If this is about my PR https://github.com/apache/solr/pull/641 then I'm
happy to add a JIRA for it. I initially said that I wasn't sure if it was
big enough to warrant an issue because it was almost entirely test changes,
and even then not really functional changes. But it's 200 lines of
difference, so that's probably well past the "minor change" territory.
I don't think there is a written consensus on this, but it's come up a few
times on the mailing list before. I don't think we ever reached
consensus there either.
Mike
On Wed, Feb 16, 2022 at 2:09 AM Ishan Chattopadhyaya <
ichattopadhyaya@gmail.com> wrote:
> IMO, any code change should have a JIRA and CHANGES.txt. Substantial ref
> guide changes should have a JIRA.
> Refactoring should definitely get a JIRA, I'll be surprised if any
> refactoring has happened without a JIRA.
>
> On Wed, Feb 16, 2022 at 12:52 PM Eric Pugh <
> epugh@opensourceconnections.com> wrote:
>
>> Hi all! Do we have a written definition of what requires a JIRA and/or
>> an entry in CHANGES.txt? Something that could go in our developer docs?
>>
>> Is there a consensus on this? For example, changes to documentation
>> typically have NOT gone into the CHANGES.txt file. It appears that some
>> refactoring don’t need a JIRA issue as well.
>>
>> Thoughts on this?
>>
>>
>> Eric
>>
>> _______________________
>> *Eric Pugh **| *Founder & CEO | OpenSource Connections, LLC | 434.466.1467
>> | http://www.opensourceconnections.com | My Free/Busy
>> <http://tinyurl.com/eric-cal>
>> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed
>> <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
>> This e-mail and all contents, including attachments, is considered to be
>> Company Confidential unless explicitly stated otherwise, regardless
>> of whether attachments are marked as such.
>>
>>
Re: Define what requires a JIRA and an entry in CHANGES.txt?
Posted by Ishan Chattopadhyaya <ic...@gmail.com>.
IMO, any code change should have a JIRA and CHANGES.txt. Substantial ref
guide changes should have a JIRA.
Refactoring should definitely get a JIRA, I'll be surprised if any
refactoring has happened without a JIRA.
On Wed, Feb 16, 2022 at 12:52 PM Eric Pugh <ep...@opensourceconnections.com>
wrote:
> Hi all! Do we have a written definition of what requires a JIRA and/or
> an entry in CHANGES.txt? Something that could go in our developer docs?
>
> Is there a consensus on this? For example, changes to documentation
> typically have NOT gone into the CHANGES.txt file. It appears that some
> refactoring don’t need a JIRA issue as well.
>
> Thoughts on this?
>
>
> Eric
>
> _______________________
> *Eric Pugh **| *Founder & CEO | OpenSource Connections, LLC | 434.466.1467
> | http://www.opensourceconnections.com | My Free/Busy
> <http://tinyurl.com/eric-cal>
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed
> <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
> This e-mail and all contents, including attachments, is considered to be
> Company Confidential unless explicitly stated otherwise, regardless
> of whether attachments are marked as such.
>
>