I like this idea and completely agree that we should store IDEA code
formatting/inspections settings in Git.

As far as I know there are two approaches to do it:
1. Keep .idea folder (as Furkan already pointed out) and use
.gitignore to filter out non-relevant files (example:
https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore)
2. Export as XML files (Preferences -> Editor -> Inspections ->
Export...) and keep them outside of .idea folder (example:
https://github.com/apache/helix/wiki/Helix-Code-Style-in-Intellij-IDE).

Both have their pros and cons:
With (1) every new member has all the settings ready once he/she opens
the project in IDEA, while (2) requires some manual steps to import
those settings.
On the other hand, if developer tweaks (1) settings locally (f.e.
disables Javadoc inspections) then settings file will be marked by Git
as modified, which can lead to unintended commits.

Regards,
Sergey

On Sun, May 24, 2020 at 10:50 AM Sergey Kamov <[email protected]> wrote:
>
> Hi Nikita!
>
>
> > 1. I wouldn't separate Javadoc vs. non-Javadoc. Everyone should care about
> > Javadoc (or generally, code-level) documentation. Javadoc is part of the
> > code.
>
> I guess that not all developers can write good quality javadoc, But to
> avoid warnings in their classes (because difficult to filter warnings to
> javadoc and another) , these developers can write any formal javadoc,
> and later, without warnings, will be difficult to find and fix such javadoc
>
> What do you think?
>
> Regards,
>
> Sergey
>
>
> >
>
> >
> > We would also need a separate doc for Java and Scala coding guidelines. Not
> > everything can be (or should be) enforced by IDEA.
> >
> > Thanks,
> > --
> > Nikita Ivanov
> >
> >
> >
> > On Sat, May 23, 2020 at 8:53 AM Sergey Kamov <[email protected]> wrote:
> >
> >> Hi Furkan!
> >>
> >> Yes, prepare and share IDEA configuration properties for all team members.
> >>
> >>
> >> Regards,
> >>
> >> Sergey
> >>
> >> 23.05.2020 17:18, Furkan KAMACI пишет:
> >>> Hi Sergey,
> >>>
> >>> Do you mean something like this:
> >>> https://github.com/apache/druid/tree/master/.idea
> >>>
> >>> Kind Regards,
> >>> Furkan KAMACI
> >>>
> >>> On Sat, May 23, 2020 at 1:46 PM Sergey Kamov <[email protected]>
> >> wrote:
> >>>> I guess we need to have some common configuration for our IDEs to have
> >>>> same project files' warnings for all team members.
> >>>> Can we add these configuration files under git?
> >>>>
> >>>> One additional point - maybe better to have 2 different configs? The
> >>>> reason is javadoc warnings are optional.
> >>>>
> >>>>     - Some team members (which work on javadoc) need these warnings
> >>>>     - Other team members don't need such warnings because they can
> >>>> distract them (they will ignore such warnings and can skip as result
> >>>> some other)
> >>>>
> >>>>
> >>>> Regards,
> >>>>
> >>>> Sergey
> >>>>
> >>>>

Reply via email to