You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "Daniel Stieglitz (Jira)" <ji...@apache.org> on 2025/03/28 19:04:00 UTC

[jira] [Commented] (NIFI-14398) Corrections and improvements to Contributor Guide

    [ https://issues.apache.org/jira/browse/NIFI-14398?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17939290#comment-17939290 ] 

Daniel Stieglitz commented on NIFI-14398:
-----------------------------------------

I noticed the Checkstyle paragraph for Intellij needs updating as well.
 * It would be helpful to indicate to users to download the Checkstyle plugin which corresponds to their version of Intellij.
 * The menu items look as though they may have changed. For example I am using Intellij 2024.1 Community EditionĀ 
and I had to follow Settings -> Tools -> Checkstyle -> Configuration File (use + sign to add from file system and give the rules a meaningful description name e.g. Apache NIFI Checkstyle Rules)
 * It would also be helpful to add directions on how to use E.g. To use View -> Tool Windows -> Checkstyle.
In Rules Dropdown choose the description given in previous step and choose to click from the various icons whether to run on a given file, module, all modified files or the whole project.

> Corrections and improvements to Contributor Guide
> -------------------------------------------------
>
>                 Key: NIFI-14398
>                 URL: https://issues.apache.org/jira/browse/NIFI-14398
>             Project: Apache NiFi
>          Issue Type: Improvement
>            Reporter: Daniel Stieglitz
>            Priority: Minor
>
> The following corrections and suggestions should be applied to the [Contributor Guide|https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide]
>  * Replace reference of AsciiDoc with Markdown (probably will require some rewriting)
>  * References to 1.x should be replaced with 2.x
>  * Remove option of submitting a patch file as that in practice is not accepted.
>  * Indicate the necessity to fill out the PR template when submitting a PR.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)