docs: readme

reinaldocosta · Mar 27, 2024 · 32fbe8c · 32fbe8c
1 parent 5e11f58
commit 32fbe8c
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 3 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,7 +1,7 @@
 name: Developer Continuous Integration
 
 on:
-  push:
+  pull_request:
     branches:
       - main
 

diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -1,7 +1,7 @@
 name: LintProject
 
 on:
-  push:
+  pull_request:
     branches:
       - main
 

diff --git a/README.MD b/README.MD
@@ -0,0 +1,12 @@
+# Repo to showcase some actions
+
+## Linting
+
+In some cases, our projects are not being linted, or the linting tool stop working in the middle of the project. 
+To help up with that, we can run our Lint in the actions instead of having hooks. 
+
+This action help us in two great ways:
+- Annotating the linting issue on the PR. 
+
+- Fixing auto. some linting issues
+![alt text](image.png)
diff --git a/image.png b/image.png
diff --git a/index.ts b/index.ts
@@ -1 +1,2 @@
-console.log('hello world')
+console.log('hello world')
+const unused = 'It will generate an PR annotation'