refactor: after review

raccoongang · Dec 10, 2024 · df51d89 · df51d89
1 parent 384dcdc
commit df51d89
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -23,12 +23,6 @@ Include `rg-frontend-linters` as a dependency:
 }
 ```
 
-Install the dependency:
-
-```bash
-    npm install
-```
-
 ### 2. Create a configuration file
 
 Add a configuration file for the desired linter in the root of your project. For example, to configure Stylelint:

diff --git a/RG_CHANGELOG.rst b/RG_CHANGELOG.rst
@@ -9,18 +9,13 @@ and this project adheres to customized Semantic Versioning e.g.: `redwood-rg.1`
 [Unreleased]
 ************
 
-[redwood-rg.3] 2024-11-28 (Redwood RG release)
+2024-11-28
 ****************************************
 
 Added:
 =====
-* add CI checkers: tests, linters checkers (RGInt-303)
-* add configs and tests (RGInt-303)
-* add documentation (RGInt-303)
+* initialize project structure and add default configs (RGInt-303)
 
-[redwood-rg.3] 2024-11-27 (Redwood RG release)
-****************************************
-
-Added:
-=====
-* initialize project structure (RGInt-303)
+- add CI checkers: tests, linters checkers
+- add configs and tests
+- add documentation
diff --git a/docs/decisions/0001-rg-frontend-linters.rst b/docs/decisions/0001-rg-frontend-linters.rst
@@ -1,16 +1,6 @@
 Technical Solution Overview: RG Frontend Linters
 ================================================
 
-RG Frontend Linters
-       |
-       |---> ESLint Config
-       |---> Stylelint Config
-       |---> CommitLint Config
-       |         |
-       |         |---> brand-openedx
-       |         |---> frontend-component-header
-       |         |---> frontend-component-footer
-
 **RG Frontend Linters** is a solution designed to standardize configurations for **ESLint**, **Stylelint**, and **CommitLint**,
 ensuring consistent code quality, styling, and commit message validation across projects. By abstracting the configuration logic into reusable modules,
 this approach streamlines the integration process for developers, reduces onboarding time, and enforces consistent standards across teams and projects.