commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Benedikt Ritter <brit...@apache.org>
Subject Re: [TEXT] Proposal for StrLookup API (TEXT-80)
Date Sun, 21 May 2017 22:54:46 GMT
Hello Kapil,

> Am 21.05.2017 um 16:26 schrieb Kapil Neurgaonkar <caps.5k@gmail.com>:
> 
> Hi All,
> 
> I'm Kapil, an aspirant new-comer to Apache Dev Community interested in
> contributing to project Commons Text.

That’s great, welcome to our community! Please have a look at the docs for contributors
[1] and please sign an ICLA [2] if you plan to contribute on a regular basis.

> 
> To start with I would like to solve an issue in StrLookup API [1].
> Looking forward to having a mentor who can help me start-up and guide
> through this activity.
> 
> Looks like a proposal has already been mentioned in JIRA item [1]. I
> went through details mentioned and analyzed impact of change. As
> mentioned, I think removal of type parameter <V> and changing lookup
> map's type from <V> to <?> should be good.
> 
> Regarding impact, changes are required in StrLookup, StrLookupTest,
> StrSubstitutor and StrSubstitutorTest within commons text. Also
> respective test cases and JavaDocs need to be updated accordingly.
> 
> I hope this is good to start. Request you to kindly validate my proposal.

TEXT-80 looks valid to me. So removing the generic type parameters sounds like a good idea.
Note that this API has already been released, so we need to make sure, we don’t break anything.
We use the maven clirr plugin to check our APIs. So after you’ve implemented your fix, in
this case you should check the clirr report. It should not have errors.

You can submit your proposal as a pull request against our GitHub mirror [3].

> 
> Please mention in case anything got missed or needs correction.

Regards,
Benedikt

[1] https://community.apache.org/newcomers/ <https://community.apache.org/newcomers/>
[2] https://www.apache.org/licenses/icla.pdf <https://www.apache.org/licenses/icla.pdf>

[3] https://github.com/apache/commons-text <https://github.com/apache/commons-text>


> 
> Thanks,
> Kapil Neurgaonkar
> Profile - https://www.linkedin.com/in/kapilneurgaonkar/
> 
> [1] - https://issues.apache.org/jira/browse/TEXT-80
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
> 


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message