You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Sandra Parsick <sp...@web.de> on 2020/12/22 13:33:45 UTC
[Idea] Coding Guidelines for Maven Contribution Newbies
Hello dev-list,
some weeks ago, I have started creating some Pull Requests for the Maven
JLink Plugin [1]. There were many hints about coding rules or decision
which version / libs etc should be used and more. So I need some
iterations till a trivial (IMHO) PR was accepted or in one case to find
out the PR was completely unnecessary. That was a little bit frustating.
I think it would be easier for new contributor to have a guideline or
checklist of things to consider. I would love to help create such a
checklist or guideline to lower the barrier to entry for contributing. I
already discuss the idea with Ben and he has agreed to help. So what do
you think about this idea? If this idea finds approval, where is the
best place to place it?
Best regards,
Sandra
[1]
https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Elliotte Rusty Harold <el...@ibiblio.org>.
On Sun, Dec 27, 2020 at 10:24 AM Benjamin Marwell <bm...@apache.org> wrote:
>
> Hi Sandra,
> hi everyone,
>
> here’s another subtopic:
>
> I recently added a comment like this: // [issue-##]: Do call method x
> because of side effect x
> But I got a review "the comment is redundant because of the git log".
> Is there a policy on where and how to put comments in the code?
>
There is no such policy.
As a matter of good programming, IMHO if code requires an explanation
and cannot be clarified to the point where it's self-evident, then
comments are useful. A Git comment is **not** a substitute for an
inline comment. Issue numbers are sometimes useful for problems that
are too complex to be fully elaborated in a few lines of comments,
whether in git or Java.
Whether this particular code needed a comment I don't know.
--
Elliotte Rusty Harold
elharo@ibiblio.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Benjamin Marwell <bm...@apache.org>.
Hi Sandra,
hi everyone,
here’s another subtopic:
I recently added a comment like this: // [issue-##]: Do call method x
because of side effect x
But I got a review "the comment is redundant because of the git log".
Is there a policy on where and how to put comments in the code?
Reference:
https://maven.apache.org/guides/development/guide-maven-development.html
Am Di., 22. Dez. 2020 um 14:34 Uhr schrieb Sandra Parsick <sp...@web.de>:
> Hello dev-list,
>
> some weeks ago, I have started creating some Pull Requests for the Maven
> JLink Plugin [1]. There were many hints about coding rules or decision
> which version / libs etc should be used and more. So I need some
> iterations till a trivial (IMHO) PR was accepted or in one case to find
> out the PR was completely unnecessary. That was a little bit frustating.
> I think it would be easier for new contributor to have a guideline or
> checklist of things to consider. I would love to help create such a
> checklist or guideline to lower the barrier to entry for contributing. I
> already discuss the idea with Ben and he has agreed to help. So what do
> you think about this idea? If this idea finds approval, where is the
> best place to place it?
>
> Best regards,
>
> Sandra
>
> [1]
>
> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
>
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Sandra Parsick <sp...@web.de>.
> I am aware of editor-config, but it has one huge problem: you cannot refer to a centralized file.
> This means that IF we would use them, we need to keep them in sync for all ~100 repositories, which is a big no for me.
I understand your rejection. I solved this problem in one of my projects
with a Jenkins Job that replace the editor config file in all
repositories, when the centralized editor config was changed. But yes,
this is a kind of "magic" and the script has to also be maintained.
Nevertheless, I just updated the IDEA setting file, see PR [1]
[1] https://github.com/apache/maven-site/pull/222
Am 23.12.20 um 20:38 schrieb Robert Scholte:
> AFAIK the eclipse one is not outdated.
> I suggest to update these.
>
> I am aware of editor-config, but it has one huge problem: you cannot refer to a centralized file.
> This means that IF we would use them, we need to keep them in sync for all ~100 repositories, which is a big no for me.
> Updating the IDE specific files seems like the appropriate way to handle this.
>
> thanks,
> Robert
> On 23-12-2020 12:39:11, Sandra Parsick <sp...@web.de> wrote:
>> those are outdated – not everything you need is included, at least for
>> IntelliJ.
>> YMMV when using those.
>
> If those are already outdated and those need an update, maybe it is a
> good point to introduce editorconfig [1]. The advantage of editorconfig
> is that you have one config file for "all" IDEs. That would decrease the
> maintenance effort. You can also generate it from your checkstyle config
> file.
>
>> There is a lot which could be done.
>> E.g. updating those files, some general code guidelines (like: do not use
>> guard statements, rather use an else), etc., when (not) to use Optionals,
>> when to use which Logger, when to keep compatibility to Java 7/8 for plugin
>> x/y…
>
> Yes, that is the main pain point!
>
>> But speaking about code style: I saw Christian (junit) using a
>> fmt-maven-plugin [1].
>> That would be helpful, too, unless checkstyle can do the same now.
>
> I have a look on it. It is great, if you follow the Google Coding style.
> You can't configure your own style.
>
> [1]: https://editorconfig.org/
>
> Am 22.12.20 um 17:00 schrieb Benjamin Marwell:
>> Hi Anders,
>>
>> those are outdated – not everything you need is included, at least for
>> IntelliJ.
>> YMMV when using those.
>>
>> There is a lot which could be done.
>> E.g. updating those files, some general code guidelines (like: do not use
>> guard statements, rather use an else), etc., when (not) to use Optionals,
>> when to use which Logger, when to keep compatibility to Java 7/8 for plugin
>> x/y…
>>
>> It is not just about code style!
>>
>> But speaking about code style: I saw Christian (junit) using a
>> fmt-maven-plugin [1].
>> That would be helpful, too, unless checkstyle can do the same now.
>>
>> [1]:
>> https://github.com/sormuras/junit-platform-maven-plugin/blob/master/pom.xml#L294-L314
>>
>> Am Di., 22. Dez. 2020 um 14:51 Uhr schrieb Anders Hammar
>>> :
>>
>>> There are settings files here:
>>> http://maven.apache.org/developers/conventions/code.html
>>>
>>> /Anders
>>>
>>> On Tue, Dec 22, 2020 at 2:47 PM Gary Gregory
>>> wrote:
>>>
>>>> It would be great if one could download Eclipse or Idea settings files,
>>> or
>>>> better yet, include them in each repo.
>>>>
>>>> Gary
>>>>
>>>> On Tue, Dec 22, 2020, 08:34 Sandra Parsick wrote:
>>>>
>>>>> Hello dev-list,
>>>>>
>>>>> some weeks ago, I have started creating some Pull Requests for the
>>> Maven
>>>>> JLink Plugin [1]. There were many hints about coding rules or decision
>>>>> which version / libs etc should be used and more. So I need some
>>>>> iterations till a trivial (IMHO) PR was accepted or in one case to find
>>>>> out the PR was completely unnecessary. That was a little bit
>>> frustating.
>>>>> I think it would be easier for new contributor to have a guideline or
>>>>> checklist of things to consider. I would love to help create such a
>>>>> checklist or guideline to lower the barrier to entry for contributing.
>>> I
>>>>> already discuss the idea with Ben and he has agreed to help. So what do
>>>>> you think about this idea? If this idea finds approval, where is the
>>>>> best place to place it?
>>>>>
>>>>> Best regards,
>>>>>
>>>>> Sandra
>>>>>
>>>>> [1]
>>>>>
>>>>>
>>>>
>>> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
>>>>>
>>>>>
>>>>
>>>
>>
>
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Robert Scholte <rf...@apache.org>.
AFAIK the eclipse one is not outdated.
I suggest to update these.
I am aware of editor-config, but it has one huge problem: you cannot refer to a centralized file.
This means that IF we would use them, we need to keep them in sync for all ~100 repositories, which is a big no for me.
Updating the IDE specific files seems like the appropriate way to handle this.
thanks,
Robert
On 23-12-2020 12:39:11, Sandra Parsick <sp...@web.de> wrote:
> those are outdated – not everything you need is included, at least for
> IntelliJ.
> YMMV when using those.
If those are already outdated and those need an update, maybe it is a
good point to introduce editorconfig [1]. The advantage of editorconfig
is that you have one config file for "all" IDEs. That would decrease the
maintenance effort. You can also generate it from your checkstyle config
file.
> There is a lot which could be done.
> E.g. updating those files, some general code guidelines (like: do not use
> guard statements, rather use an else), etc., when (not) to use Optionals,
> when to use which Logger, when to keep compatibility to Java 7/8 for plugin
> x/y…
Yes, that is the main pain point!
> But speaking about code style: I saw Christian (junit) using a
> fmt-maven-plugin [1].
> That would be helpful, too, unless checkstyle can do the same now.
I have a look on it. It is great, if you follow the Google Coding style.
You can't configure your own style.
[1]: https://editorconfig.org/
Am 22.12.20 um 17:00 schrieb Benjamin Marwell:
> Hi Anders,
>
> those are outdated – not everything you need is included, at least for
> IntelliJ.
> YMMV when using those.
>
> There is a lot which could be done.
> E.g. updating those files, some general code guidelines (like: do not use
> guard statements, rather use an else), etc., when (not) to use Optionals,
> when to use which Logger, when to keep compatibility to Java 7/8 for plugin
> x/y…
>
> It is not just about code style!
>
> But speaking about code style: I saw Christian (junit) using a
> fmt-maven-plugin [1].
> That would be helpful, too, unless checkstyle can do the same now.
>
> [1]:
> https://github.com/sormuras/junit-platform-maven-plugin/blob/master/pom.xml#L294-L314
>
> Am Di., 22. Dez. 2020 um 14:51 Uhr schrieb Anders Hammar
>> :
>
>> There are settings files here:
>> http://maven.apache.org/developers/conventions/code.html
>>
>> /Anders
>>
>> On Tue, Dec 22, 2020 at 2:47 PM Gary Gregory
>> wrote:
>>
>>> It would be great if one could download Eclipse or Idea settings files,
>> or
>>> better yet, include them in each repo.
>>>
>>> Gary
>>>
>>> On Tue, Dec 22, 2020, 08:34 Sandra Parsick wrote:
>>>
>>>> Hello dev-list,
>>>>
>>>> some weeks ago, I have started creating some Pull Requests for the
>> Maven
>>>> JLink Plugin [1]. There were many hints about coding rules or decision
>>>> which version / libs etc should be used and more. So I need some
>>>> iterations till a trivial (IMHO) PR was accepted or in one case to find
>>>> out the PR was completely unnecessary. That was a little bit
>> frustating.
>>>> I think it would be easier for new contributor to have a guideline or
>>>> checklist of things to consider. I would love to help create such a
>>>> checklist or guideline to lower the barrier to entry for contributing.
>> I
>>>> already discuss the idea with Ben and he has agreed to help. So what do
>>>> you think about this idea? If this idea finds approval, where is the
>>>> best place to place it?
>>>>
>>>> Best regards,
>>>>
>>>> Sandra
>>>>
>>>> [1]
>>>>
>>>>
>>>
>> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
>>>>
>>>>
>>>
>>
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Sandra Parsick <sp...@web.de>.
> those are outdated – not everything you need is included, at least for
> IntelliJ.
> YMMV when using those.
If those are already outdated and those need an update, maybe it is a
good point to introduce editorconfig [1]. The advantage of editorconfig
is that you have one config file for "all" IDEs. That would decrease the
maintenance effort. You can also generate it from your checkstyle config
file.
> There is a lot which could be done.
> E.g. updating those files, some general code guidelines (like: do not use
> guard statements, rather use an else), etc., when (not) to use Optionals,
> when to use which Logger, when to keep compatibility to Java 7/8 for plugin
> x/y…
Yes, that is the main pain point!
> But speaking about code style: I saw Christian (junit) using a
> fmt-maven-plugin [1].
> That would be helpful, too, unless checkstyle can do the same now.
I have a look on it. It is great, if you follow the Google Coding style.
You can't configure your own style.
[1]: https://editorconfig.org/
Am 22.12.20 um 17:00 schrieb Benjamin Marwell:
> Hi Anders,
>
> those are outdated – not everything you need is included, at least for
> IntelliJ.
> YMMV when using those.
>
> There is a lot which could be done.
> E.g. updating those files, some general code guidelines (like: do not use
> guard statements, rather use an else), etc., when (not) to use Optionals,
> when to use which Logger, when to keep compatibility to Java 7/8 for plugin
> x/y…
>
> It is not just about code style!
>
> But speaking about code style: I saw Christian (junit) using a
> fmt-maven-plugin [1].
> That would be helpful, too, unless checkstyle can do the same now.
>
> [1]:
> https://github.com/sormuras/junit-platform-maven-plugin/blob/master/pom.xml#L294-L314
>
> Am Di., 22. Dez. 2020 um 14:51 Uhr schrieb Anders Hammar <anders@hammar.net
>> :
>
>> There are settings files here:
>> http://maven.apache.org/developers/conventions/code.html
>>
>> /Anders
>>
>> On Tue, Dec 22, 2020 at 2:47 PM Gary Gregory <ga...@gmail.com>
>> wrote:
>>
>>> It would be great if one could download Eclipse or Idea settings files,
>> or
>>> better yet, include them in each repo.
>>>
>>> Gary
>>>
>>> On Tue, Dec 22, 2020, 08:34 Sandra Parsick <sp...@web.de> wrote:
>>>
>>>> Hello dev-list,
>>>>
>>>> some weeks ago, I have started creating some Pull Requests for the
>> Maven
>>>> JLink Plugin [1]. There were many hints about coding rules or decision
>>>> which version / libs etc should be used and more. So I need some
>>>> iterations till a trivial (IMHO) PR was accepted or in one case to find
>>>> out the PR was completely unnecessary. That was a little bit
>> frustating.
>>>> I think it would be easier for new contributor to have a guideline or
>>>> checklist of things to consider. I would love to help create such a
>>>> checklist or guideline to lower the barrier to entry for contributing.
>> I
>>>> already discuss the idea with Ben and he has agreed to help. So what do
>>>> you think about this idea? If this idea finds approval, where is the
>>>> best place to place it?
>>>>
>>>> Best regards,
>>>>
>>>> Sandra
>>>>
>>>> [1]
>>>>
>>>>
>>>
>> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
>>>>
>>>>
>>>
>>
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Benjamin Marwell <bm...@apache.org>.
Hi Anders,
those are outdated – not everything you need is included, at least for
IntelliJ.
YMMV when using those.
There is a lot which could be done.
E.g. updating those files, some general code guidelines (like: do not use
guard statements, rather use an else), etc., when (not) to use Optionals,
when to use which Logger, when to keep compatibility to Java 7/8 for plugin
x/y…
It is not just about code style!
But speaking about code style: I saw Christian (junit) using a
fmt-maven-plugin [1].
That would be helpful, too, unless checkstyle can do the same now.
[1]:
https://github.com/sormuras/junit-platform-maven-plugin/blob/master/pom.xml#L294-L314
Am Di., 22. Dez. 2020 um 14:51 Uhr schrieb Anders Hammar <anders@hammar.net
>:
> There are settings files here:
> http://maven.apache.org/developers/conventions/code.html
>
> /Anders
>
> On Tue, Dec 22, 2020 at 2:47 PM Gary Gregory <ga...@gmail.com>
> wrote:
>
> > It would be great if one could download Eclipse or Idea settings files,
> or
> > better yet, include them in each repo.
> >
> > Gary
> >
> > On Tue, Dec 22, 2020, 08:34 Sandra Parsick <sp...@web.de> wrote:
> >
> > > Hello dev-list,
> > >
> > > some weeks ago, I have started creating some Pull Requests for the
> Maven
> > > JLink Plugin [1]. There were many hints about coding rules or decision
> > > which version / libs etc should be used and more. So I need some
> > > iterations till a trivial (IMHO) PR was accepted or in one case to find
> > > out the PR was completely unnecessary. That was a little bit
> frustating.
> > > I think it would be easier for new contributor to have a guideline or
> > > checklist of things to consider. I would love to help create such a
> > > checklist or guideline to lower the barrier to entry for contributing.
> I
> > > already discuss the idea with Ben and he has agreed to help. So what do
> > > you think about this idea? If this idea finds approval, where is the
> > > best place to place it?
> > >
> > > Best regards,
> > >
> > > Sandra
> > >
> > > [1]
> > >
> > >
> >
> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
> > >
> > >
> >
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Anders Hammar <an...@hammar.net>.
There are settings files here:
http://maven.apache.org/developers/conventions/code.html
/Anders
On Tue, Dec 22, 2020 at 2:47 PM Gary Gregory <ga...@gmail.com> wrote:
> It would be great if one could download Eclipse or Idea settings files, or
> better yet, include them in each repo.
>
> Gary
>
> On Tue, Dec 22, 2020, 08:34 Sandra Parsick <sp...@web.de> wrote:
>
> > Hello dev-list,
> >
> > some weeks ago, I have started creating some Pull Requests for the Maven
> > JLink Plugin [1]. There were many hints about coding rules or decision
> > which version / libs etc should be used and more. So I need some
> > iterations till a trivial (IMHO) PR was accepted or in one case to find
> > out the PR was completely unnecessary. That was a little bit frustating.
> > I think it would be easier for new contributor to have a guideline or
> > checklist of things to consider. I would love to help create such a
> > checklist or guideline to lower the barrier to entry for contributing. I
> > already discuss the idea with Ben and he has agreed to help. So what do
> > you think about this idea? If this idea finds approval, where is the
> > best place to place it?
> >
> > Best regards,
> >
> > Sandra
> >
> > [1]
> >
> >
> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
> >
> >
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Gary Gregory <ga...@gmail.com>.
It would be great if one could download Eclipse or Idea settings files, or
better yet, include them in each repo.
Gary
On Tue, Dec 22, 2020, 08:34 Sandra Parsick <sp...@web.de> wrote:
> Hello dev-list,
>
> some weeks ago, I have started creating some Pull Requests for the Maven
> JLink Plugin [1]. There were many hints about coding rules or decision
> which version / libs etc should be used and more. So I need some
> iterations till a trivial (IMHO) PR was accepted or in one case to find
> out the PR was completely unnecessary. That was a little bit frustating.
> I think it would be easier for new contributor to have a guideline or
> checklist of things to consider. I would love to help create such a
> checklist or guideline to lower the barrier to entry for contributing. I
> already discuss the idea with Ben and he has agreed to help. So what do
> you think about this idea? If this idea finds approval, where is the
> best place to place it?
>
> Best regards,
>
> Sandra
>
> [1]
>
> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
>
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Sandra Parsick <sp...@web.de>.
Hi all,
I started a Github repository [1], where I will collect my lessons
learned. Contribution is welcome.
Regards,
Sandra
[1] https://github.com/sparsick/maven-contribution-newbie
Am 23.12.20 um 12:29 schrieb Sandra Parsick:
>
>> welcome in the Maven dev community!
>
> Thank you :)
>
>>
>> I think a good starting point would be to simply write up your personal lessions lerned, so others can then add PRs ontop with their additions.
>
> Good idea! Is it possible to create such repository in the Apache
> organisation? Of course, I could create my own repository, but this
> feels wrong. The advantage of an "official" Apache repository is that
> every PR can be reviewed by Maven committers easier.
>
>> P.S.: Like to join us at JavaLand 2021's community workshop on becoming a Maven contributor? I think it would be very beneficial for the attendees, so we would not just have the appreciated voices of Karl-Heinz and Robert, but also your view as a first-time plugin contributor!
>
> Sure!
>
> Regards,
>
> Sandra
>
>
> Am 22.12.20 um 16:45 schrieb Markus KARG:
>> Sandra,
>>
>> welcome in the Maven dev community! :-)
>>
>> I think a good starting point would be to simply write up your personal lessions lerned, so others can then add PRs ontop with their additions.
>>
>> Regards
>> -Markus
>>
>> P.S.: Like to join us at JavaLand 2021's community workshop on becoming a Maven contributor? I think it would be very beneficial for the attendees, so we would not just have the appreciated voices of Karl-Heinz and Robert, but also your view as a first-time plugin contributor!
>>
>> -----Ursprüngliche Nachricht-----
>> Von: Sandra Parsick [mailto:sparsick@web.de]
>> Gesendet: Dienstag, 22. Dezember 2020 14:34
>> An: dev@maven.apache.org
>> Betreff: [Idea] Coding Guidelines for Maven Contribution Newbies
>>
>> Hello dev-list,
>>
>> some weeks ago, I have started creating some Pull Requests for the Maven JLink Plugin [1]. There were many hints about coding rules or decision which version / libs etc should be used and more. So I need some iterations till a trivial (IMHO) PR was accepted or in one case to find out the PR was completely unnecessary. That was a little bit frustating.
>> I think it would be easier for new contributor to have a guideline or checklist of things to consider. I would love to help create such a checklist or guideline to lower the barrier to entry for contributing. I already discuss the idea with Ben and he has agreed to help. So what do you think about this idea? If this idea finds approval, where is the best place to place it?
>>
>> Best regards,
>>
>> Sandra
>>
>> [1]
>> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>
Re: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Sandra Parsick <sp...@web.de>.
> welcome in the Maven dev community!
Thank you :)
>
> I think a good starting point would be to simply write up your personal lessions lerned, so others can then add PRs ontop with their additions.
Good idea! Is it possible to create such repository in the Apache
organisation? Of course, I could create my own repository, but this
feels wrong. The advantage of an "official" Apache repository is that
every PR can be reviewed by Maven committers easier.
> P.S.: Like to join us at JavaLand 2021's community workshop on becoming a Maven contributor? I think it would be very beneficial for the attendees, so we would not just have the appreciated voices of Karl-Heinz and Robert, but also your view as a first-time plugin contributor!
Sure!
Regards,
Sandra
Am 22.12.20 um 16:45 schrieb Markus KARG:
> Sandra,
>
> welcome in the Maven dev community! :-)
>
> I think a good starting point would be to simply write up your personal lessions lerned, so others can then add PRs ontop with their additions.
>
> Regards
> -Markus
>
> P.S.: Like to join us at JavaLand 2021's community workshop on becoming a Maven contributor? I think it would be very beneficial for the attendees, so we would not just have the appreciated voices of Karl-Heinz and Robert, but also your view as a first-time plugin contributor!
>
> -----Ursprüngliche Nachricht-----
> Von: Sandra Parsick [mailto:sparsick@web.de]
> Gesendet: Dienstag, 22. Dezember 2020 14:34
> An: dev@maven.apache.org
> Betreff: [Idea] Coding Guidelines for Maven Contribution Newbies
>
> Hello dev-list,
>
> some weeks ago, I have started creating some Pull Requests for the Maven JLink Plugin [1]. There were many hints about coding rules or decision which version / libs etc should be used and more. So I need some iterations till a trivial (IMHO) PR was accepted or in one case to find out the PR was completely unnecessary. That was a little bit frustating.
> I think it would be easier for new contributor to have a guideline or checklist of things to consider. I would love to help create such a checklist or guideline to lower the barrier to entry for contributing. I already discuss the idea with Ben and he has agreed to help. So what do you think about this idea? If this idea finds approval, where is the best place to place it?
>
> Best regards,
>
> Sandra
>
> [1]
> https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
AW: [Idea] Coding Guidelines for Maven Contribution Newbies
Posted by Markus KARG <ma...@headcrashing.eu>.
Sandra,
welcome in the Maven dev community! :-)
I think a good starting point would be to simply write up your personal lessions lerned, so others can then add PRs ontop with their additions.
Regards
-Markus
P.S.: Like to join us at JavaLand 2021's community workshop on becoming a Maven contributor? I think it would be very beneficial for the attendees, so we would not just have the appreciated voices of Karl-Heinz and Robert, but also your view as a first-time plugin contributor!
-----Ursprüngliche Nachricht-----
Von: Sandra Parsick [mailto:sparsick@web.de]
Gesendet: Dienstag, 22. Dezember 2020 14:34
An: dev@maven.apache.org
Betreff: [Idea] Coding Guidelines for Maven Contribution Newbies
Hello dev-list,
some weeks ago, I have started creating some Pull Requests for the Maven JLink Plugin [1]. There were many hints about coding rules or decision which version / libs etc should be used and more. So I need some iterations till a trivial (IMHO) PR was accepted or in one case to find out the PR was completely unnecessary. That was a little bit frustating.
I think it would be easier for new contributor to have a guideline or checklist of things to consider. I would love to help create such a checklist or guideline to lower the barrier to entry for contributing. I already discuss the idea with Ben and he has agreed to help. So what do you think about this idea? If this idea finds approval, where is the best place to place it?
Best regards,
Sandra
[1]
https://github.com/apache/maven-jlink-plugin/pulls?q=is%3Apr+is%3Aclosed+author%3Asparsick
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org