Merge pull request #7 from ioncakephper:feature/lint-markdown

Enhance CI workflow and Markdown linting support

Author: ioncakephper

.github/workflows/ci.yml

@@ -27,5 +27,9 @@ jobs:
         run: npm run lint
       - name: Check formatting
         run: npm run format
+      - name: Lint Markdown files
+        run: npm run lint:md
+      - name: Check Markdown formatting
+        run: npm run format:md
       - name: Run tests
         run: npm test

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "MD013": false
+}

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-shytiger@yahoo.com
+<shytiger@yahoo.com>
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -20,7 +20,7 @@ Please take a moment to review this document to understand our contribution guid
 
 ## Code of Conduct
 
-This project and everyone participating in it is governed by the [js-quality-starter Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to shytiger@yahoo.com.
+This project and everyone participating in it is governed by the [js-quality-starter Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <shytiger@yahoo.com>.
 
 ## How to Contribute
 

README.md

@@ -56,12 +56,14 @@ In the project directory, you can run:
 - `npm run lint:fix`: Lints and automatically fixes fixable issues.
 - `npm run format`: Checks for formatting issues with Prettier.
 - `npm run format:fix`: Formats all supported files with Prettier.
+- `npm run format:md`: Checks for formatting issues with Prettier for Markdown files.
+- `npm run format:md:fix`: Formats all Markdown files with Prettier.
 
 ## How It Works
 
 ### Pre-commit Hooks
 
-This project uses `Husky` and `lint-staged` to run `eslint --fix` and `prettier --write` on staged `.js` files every time you make a commit. This automated quality gate ensures that no code that violates the style guide ever gets into the codebase.
+This project uses `Husky` and `lint-staged` to run `eslint --fix`, `prettier --write` (for both code and Markdown), and `markdownlint --fix` on staged files every time you make a commit. This automated quality gate ensures that no code or documentation that violates the style guide ever gets into the codebase.
 
 If a file has linting or formatting errors, the tools will attempt to fix them automatically. If they can, the fixed code is what gets committed. If they can't, the commit is aborted so you can fix the issues manually.
 
@@ -76,8 +78,9 @@ Both workflows perform the following steps across multiple Node.js versions (18.
 
 1. **Install dependencies** using `npm ci` for fast, reliable installs.
 2. **Lint code** with `npm run lint`.
-3. **Check formatting** with `npm run format`.
-4. **Run tests** with `npm test`.
+3. **Check Markdown formatting** with `npm run format:md`.
+4. **Check formatting** with `npm run format`.
+5. **Run tests** with `npm test`.
 
 ## Customization