add pr-validation

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,26 +1,35 @@
 ---
-name: Bug report
-about: Create a report to help us improve
-title: ''
+name: Bug Report
+about: Report an issue or inaccuracy in the documentation or guidelines.
+title: '[Bug]: Short description of the bug'
 labels: bug
 assignees: ''
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Describe the Bug
+
+A clear and concise description of what the bug or inaccuracy is. This could be
+a typo, incorrect information, a broken link, or a misleading instruction.
+
+## To Reproduce
+
+Steps to reproduce the behavior (if applicable):
+
+1. Go to '[Page/File Name]'
+2. Navigate to '[Section/Line Number]'
+3. See '[Specific Issue]'
+
+## Expected Behavior
+
+A clear and concise description of what you expected to happen or what the
+correct information should be.
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '...'
-3. See error
+## Screenshots
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+If applicable, add screenshots to help explain the problem (e.g., broken link,
+formatting issue).
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Additional Context
 
-**Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here (e.g., browser, device, specific
+tool version if relevant to an instruction).

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,15 +1,27 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
-title: ''
+name: Feature Request
+about: Suggest an idea for new content, guidelines, or improvements to the kit.
+title: '[Feature]: Short description of the feature'
 labels: enhancement
 assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
+## **Is your feature request related to a problem? Please describe**
+
+A clear and concise description of what the problem is. (e.g., "The current
+React guidelines don't cover state management with Zustand, which is a common
+pattern.")
+
+## Describe the Solution You'd Like
+
+A clear and concise description of what you want to happen. (e.g., "Add a new
+guideline file for Zustand state management in the React section.")
+
+## Describe Alternatives You've Considered
+
+A clear and concise description of any alternative solutions or features you've
+considered.
 
-**Describe the solution you'd like**
+## Additional Context
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,48 +1,76 @@
-# Pull Request Template 🚀
+---
+name: Pull Request
+about: Propose changes to the Code Instructions Kit
+title: "[TYPE]: Short description of changes"
+<!--
+Thank you for contributing! Please prefix your PR title with one of the following:
+- [DOCS] for documentation changes
+- [FEAT] for new features or guidelines
+- [FIX] for bug fixes
+- [CHORE] for maintenance tasks (e.g., updating templates)
+-->
+labels: ''
+assignees: ''
 
-## Description
+---
 
-Please include a summary of the changes and the related issue.  
-Also, describe the motivation behind these changes and how they address the problem.
+## Pull Request Checklist
 
-Fixes #(issue number) <!-- Replace with the issue number this PR fixes, if applicable -->
+Please ensure you have completed the following steps before submitting your pull
+request. This helps us review and merge your changes efficiently.
 
----
+### General Checks
 
-## Type of change
+- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines.
+- [ ] My changes are clearly described below.
+- [ ] My changes are focused on a single concern (e.g., one feature, one bug
+      fix, one set of related documentation updates).
 
-- [ ] Bug fix (non-breaking change which fixes an issue)  
-- [ ] New feature (non-breaking change which adds functionality)  
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)  
-- [ ] Documentation update  
+### Content & Documentation Checks
 
----
+- [ ] My changes are accurate and up-to-date.
+- [ ] The language used is clear, concise, and professional.
+- [ ] I have checked for any typos, grammatical errors, or spelling mistakes.
+- [ ] All new or modified Markdown files (`.md`) adhere to consistent formatting
+      (e.g., heading levels, list styles, code block formatting).
+- [ ] If I added new guideline files (e.g., in `.gemini-guidelines/`), I have
+      updated the corresponding `GEMINI.md` file to reference them.
+- [ ] If I modified existing guideline files, I have ensured that any references
+      to them in `GEMINI.md` are still accurate.
+- [ ] All internal and external links within the modified content are valid and
+      working.
 
-## Checklist
+### Specific to `GEMINI.md` and `.gemini-guidelines`
 
-- [ ] My code follows the style guidelines of this project  
-- [ ] I have performed a self-review of my own code  
-- [ ] I have commented my code, particularly in hard-to-understand areas  
-- [ ] I have made corresponding changes to the documentation  
-- [ ] My changes generate no new warnings  
-- [ ] I have added tests that prove my fix is effective or that my feature works  
-- [ ] New and existing tests pass locally with my changes  
+- [ ] If adding a new stack/framework, I have created both the `GEMINI.md` and
+      the `.gemini-guidelines/` directory with at least an `overview.md`.
+- [ ] I have ensured that the `GEMINI.md` file correctly references all files
+      within its `.gemini-guidelines/` directory using the
+      `.gemini-guidelines/filename.md` format.
 
----
+### Self-Review
 
-## How Has This Been Tested?
-
-Please describe the tests that you ran to verify your changes.  
-Include details on how to reproduce and test this.  
+- [ ] I have reviewed my own code/content changes.
+- [ ] I have tested any instructions or examples I've added to ensure they work
+      as described.
 
 ---
 
-## Screenshots (if applicable)
+## Description of Changes
+
+Please provide a detailed description of your changes here. Explain the problem
+you're solving, the feature you're adding, or the documentation you're
+improving.
 
-Add screenshots to help explain your changes here.
+_(Example: "This PR adds new guidelines for Python FastAPI, including API design
+and data validation. It also updates the main README to reflect the new
+stack.")_
 
 ---
 
-## Additional Notes
+## Related Issues (Optional)
 
-Anything else reviewers should know about this PR.
+If this PR addresses any open issues, please link them here (e.g.,
+`Closes #123`).
+
+---

.github/workflows/markdown-lint.yml

@@ -0,0 +1,20 @@
+name: Markdown Lint
+
+on:
+  pull_request:
+    branches:
+      - main # Or your default branch name
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install markdownlint-cli
+        run: npm install -g markdownlint-cli2
+
+      - name: Run markdownlint
+        # FIX: Changed exclusion patterns from '#' to '!'
+        run: markdownlint-cli2 --config .markdownlint.jsonc "**/*.md" "!node_modules" "!.git"

.markdownlint.jsonc

@@ -0,0 +1,38 @@
+// .markdownlint.jsonc
+{
+    // MD007: Unordered list indentation (list-marker-space)
+    // Disable this as Prettier handles list formatting and may use 2 spaces.
+    "MD007": false,
+    "list-marker-space": false,
+    // MD013: Line length
+    // Disable this for prose as Prettier's "proseWrap: always" handles wrapping,
+    // and strict line limits can make documentation hard to read.
+    "MD013": false,
+    "line-length": false,
+    "MD031": false,
+    "MD032": false,
+    // MD026: Trailing punctuation in heading
+    // This is a good rule to enforce for clean headings. We will fix these.
+    "MD026": true,
+    // MD034: Bare URL used
+    // This is a good rule to enforce for readability. We will fix these.
+    "MD034": true,
+    // MD040: Fenced code blocks should have a language specified
+    // This is important for syntax highlighting. We will fix these.
+    "MD040": true,
+    // MD041: First line in a file should be a top-level heading
+    // This is a good practice for READMEs. We will fix this.
+    "MD041": true,
+    // MD024: Multiple headings with the same content
+    // This indicates a structural issue. We will fix this.
+    "MD024": true,
+    // MD038: Spaces inside code span elements
+    // This is a formatting issue. We will fix this.
+    "MD038": true,
+    // MD047: Files should end with a single newline character
+    // Good practice, Prettier should handle this.
+    "MD047": true,
+    // MD012: Multiple blank lines
+    // Good practice, Prettier should help with this.
+    "MD012": true
+}

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "singleQuote": true,
+    "trailingComma": "all",
+    "printWidth": 80,
+    "proseWrap": "always"
+}

CONTRIBUTING.md

@@ -1,38 +1,47 @@
 # 🛠️ Contributing to Code Instructions Kit
 
-Thank you for your interest in contributing! This repository shares high-quality, framework-specific, and stack-specific coding prompts and guidelines designed to help developers write better, cleaner, and more maintainable frontend code using Gemini CLI.
+Thank you for your interest in contributing! This repository shares
+high-quality, framework-specific, and stack-specific coding prompts and
+guidelines designed to help developers write better, cleaner, and more
+maintainable frontend code using Gemini CLI.
 
 ## How You Can Contribute
 
-- ✍️ **Add or improve instruction files** — submit best practices, tips, or templates for popular frontend frameworks or stacks.  
-- 🐞 **Fix typos or improve clarity** — clear and concise instructions make the repo more valuable.  
-- 💡 **Suggest new topics or frameworks** — if you think something important is missing, open an issue or PR.  
-- 🧪 **Add examples** — practical prompt vs. output markdowns help others understand real-world use.  
-- 🚀 **Report bugs or issues** — flag outdated or incorrect info.  
+- ✍️ **Add or improve instruction files** — submit best practices, tips, or
+  templates for popular frontend frameworks or stacks.
+- 🐞 **Fix typos or improve clarity** — clear and concise instructions make the
+  repo more valuable.
+- 💡 **Suggest new topics or frameworks** — if you think something important is
+  missing, open an issue or PR.
+- 🧪 **Add examples** — practical prompt vs. output markdowns help others
+  understand real-world use.
+- 🚀 **Report bugs or issues** — flag outdated or incorrect info.
 
 ## Contribution Guidelines
 
-- Follow existing folder and naming conventions.  
-- Write in clear, concise English.  
-- Use consistent markdown formatting.  
-- Be respectful and constructive in reviews and discussions.  
-- Keep instructions practical and actionable for Gemini CLI users.  
-- For major changes, open an issue to discuss before submitting a PR.  
+- Follow existing folder and naming conventions.
+- Write in clear, concise English.
+- Use consistent markdown formatting.
+- Be respectful and constructive in reviews and discussions.
+- Keep instructions practical and actionable for Gemini CLI users.
+- For major changes, open an issue to discuss before submitting a PR.
 
 ## How to Submit
 
-1. Fork the repository.  
-2. Create a new branch for your change.  
-3. Make your edits or add files.  
-4. Commit with clear messages.  
-5. Push your branch and open a Pull Request against the `main` branch.  
-6. Respond to feedback and collaborate during review.  
+1. Fork the repository.
+2. Create a new branch for your change.
+3. Make your edits or add files.
+4. Commit with clear messages.
+5. Push your branch and open a Pull Request against the `main` branch.
+6. Respond to feedback and collaborate during review.
 
 ---
 
 ## Code of Conduct
 
-This project follows a [Code of Conduct](https://opensource.guide/code-of-conduct/). Please be kind and respectful.
+This project follows a
+[Code of Conduct](https://opensource.guide/code-of-conduct/). Please be kind and
+respectful.
 
 ---