...
Create a local branch that relates the associated JIRA issue with the branch. Such an example would be:
git checkout -b nifiNIFI-359 master
This provides instant traceability to the supporting issue and provides a means of linking discussion. Please note that the relation between branch name and JIRA issue ID is 'case-sensitive', i.e. 'nifi-359' or 'NiFi-359' branch doesn't provide traceability.
Test your changes
For code changes, ensure that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder. Please write or update unit tests to verify your changes.
...
List the current files that have changes
$ git status
On branch nifiNIFI-359
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)
...
$ git add nifi-docs/src/main/asciidoc/contributor-guide.adoc
$ git status
On branch nifiNIFI-359
Changes to be committed:
(use "git reset HEAD <file>..." to unstage)
...
In the interest of providing traceability, it is helpful to lead off your commit with the associated JIRA issue number and a summary of the change this commit is providing. Such an example is:
$ git commit -m "nifiNIFI-359 Adding a guide for procedure and best practices in contributing to the project."
...