From 12e264db24869c57a5f3b58109d4644eb9322b29 Mon Sep 17 00:00:00 2001
From: Owais Kazi <owaiskazi19@gmail.com>
Date: Tue, 12 Apr 2022 18:59:14 +0000
Subject: [PATCH] Updated DEVELOPER GUIDE

Signed-off-by: Owais Kazi <owaiskazi19@gmail.com>
---
 .github/CODEOWNERS                           |  3 ++-
 .idea/inspectionProfiles/Project_Default.xml |  2 +-
 .linelint.yml                                |  4 +++-
 DEVELOPER_GUIDE.md                           | 16 ++++++++++++++++
 4 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index d038ec8b537d2..5dfa9099866d1 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,2 +1,3 @@
 # This should match the owning team set up in https://github.com/orgs/opensearch-project/teams
-*   @opensearch-project/opensearch-core
\ No newline at end of file
+*   @opensearch-project/opensearch-core
+
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
index 43a48d48b0613..5cf789707c58c 100644
--- a/.idea/inspectionProfiles/Project_Default.xml
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -6,4 +6,4 @@
       <option name="m_ignoreExpressionsContainingConstants" value="true" />
     </inspection_tool>
   </profile>
-</component>
+</component>
\ No newline at end of file
diff --git a/.linelint.yml b/.linelint.yml
index b5979819a7ae2..9e2c2c98acad4 100644
--- a/.linelint.yml
+++ b/.linelint.yml
@@ -4,13 +4,14 @@ autofix: true
 ignore:
   - .git/
   - .gradle/
+  - .idea/
   - '*.sha1'
   - '*.txt'
   - '.github/CODEOWNERS'
   - 'buildSrc/src/testKit/opensearch.build/LICENSE'
   - 'buildSrc/src/testKit/opensearch.build/NOTICE'
   - 'server/licenses/apache-log4j-extras-DEPENDENCIES'
-  #Empty files
+  # Empty files
   - 'doc-tools/missing-doclet/bin/main/org/opensearch/missingdoclet/MissingDoclet.class'
   - 'buildSrc/src/integTest/resources/org/opensearch/gradle/internal/fake_git/remote/build.gradle'
   - 'buildSrc/src/integTest/resources/org/opensearch/gradle/internal/fake_git/remote/distribution/archives/oss-darwin-tar/build.gradle'
@@ -21,6 +22,7 @@ ignore:
   - 'buildSrc/src/testKit/opensearch.build/settings.gradle'
   - 'buildSrc/src/testKit/reaper/settings.gradle'
   - 'buildSrc/src/testKit/symbolic-link-preserving-tar/settings.gradle'
+  - 'buildSrc/src/testKit/testingConventions/empty_test_task/.gitignore'
   - 'client/rest-high-level/src/main/resources/META-INF/services/org.opensearch.plugins.spi.NamedXContentProvider'
   - 'distribution/bwc/bugfix/build.gradle'
   - 'distribution/bwc/maintenance/build.gradle'
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
index 9b1bc933eb1e3..1dc1e7c2fb1d8 100644
--- a/DEVELOPER_GUIDE.md
+++ b/DEVELOPER_GUIDE.md
@@ -48,6 +48,7 @@
     - [Distributed Framework](#distributed-framework)
   - [Submitting Changes](#submitting-changes)
   - [Backports](#backports)
+  - [LineLint](#linelint)
 
 # Developer Guide
 
@@ -472,3 +473,18 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 ## Backports
 
 The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport <backport-branch-name>` is merged to main with the backport workflow run successfully on the PR. For example, if a PR on main needs to be backported to `1.x` branch, add a label `backport 1.x` to the PR and make sure the backport workflow runs on the PR along with other checks. Once this PR is merged to main, the workflow will create a backport PR to the `1.x` branch.
+
+## LineLint
+A linter in [`new-line.yml`](.github/workflows/new-line.yml) that validates simple newline and whitespace rules in all sorts of files. It can:
+- Recursively check a directory tree for files that do not end in a newline
+- Automatically fix these files by adding a newline or trimming extra newlines.
+
+Rules are defined in `.linelint.yml`.
+
+Executing the binary will automatically search the local directory tree for linting errors.
+
+    linelint .
+
+Pass a list of files or directories to limit your search.
+
+    linelint README.md LICENSE