Improve Documentation

vcian · Nov 23, 2023 · 158b79f · 158b79f
1 parent b4e082a
commit 158b79f
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,6 @@
 # dependencies
-/node_modules
+/node_modules
+
+#misc
+package-lock.json
+yarn.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,8 +2,8 @@
 
 _Nov 16, 2023_
 
-- Integrated [ESLint] with standard rules for consistent code quality.
-- Implemented [Prettier] for automatic code formatting and style consistency.
-- Introduced [Husky] Git hooks for pre-commit and pre-push checks.
-- Added [Lint Staged] to validate staged changes against coding standards.
+- Integrated `ESLint` with standard rules for consistent code quality.
+- Implemented `Prettier` for automatic code formatting and style consistency.
+- Introduced `Husky` Git hooks for pre-commit and pre-push checks.
+- Added `Lint Staged` to validate staged changes against coding standards.
 - Provided optimized VS Code configuration for seamless development.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
-# Contributing to [Your Project Name]
+# Contributing to Lint Sage
 
-Thank you for considering contributing to [Your Project Name]! We welcome your help and support in making this project better. This document outlines the guidelines for contributing to our project. Please take a moment to review it to ensure a smooth and effective collaboration.
+Thank you for considering contributing to Lint Sage! We welcome your help and support in making this project better. This document outlines the guidelines for contributing to our project. Please take a moment to review it to ensure a smooth and effective collaboration.
 
 ## Code of Conduct
 

diff --git a/package-lock.json b/package-lock.json