Skip to content

[WIP] Fix structure and content of CONTRIBUTING.md#14

Draft
Copilot wants to merge 1 commit intomainfrom
copilot/fix-contributing-md-structure
Draft

[WIP] Fix structure and content of CONTRIBUTING.md#14
Copilot wants to merge 1 commit intomainfrom
copilot/fix-contributing-md-structure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 23, 2026

Thanks for asking me to work on this. I will get started on it and keep this PR's description up to date as I form a plan and make progress.

Original prompt

Overview

This PR prepares the SlowGuardian repository for release by thoroughly fixing the following areas:


1. Fix CONTRIBUTING.md

The current CONTRIBUTING.md is a single, bare, run-on sentence with no structure, no formatting, no sections, and missing all standard contributor guide content. Rewrite it completely to be professional and useful. It should include:

  • Introduction — What SlowGuardian is, why contributions are welcome
  • Prerequisites — Knowledge of JavaScript/HTML5/Node.js, Git
  • Code of Conduct — Reference the existing CODE_OF_CONDUCT.md
  • How to Contribute — Step-by-step: fork → clone → branch → change → test → pull request
  • Branch Naming Conventions — e.g., feature/, fix/, docs/
  • Pull Request Guidelines — What reviewers look for; mention AI + human review
  • Code Style — Consistent formatting, use of 'use strict', 2-space indentation
  • Reporting Issues — How to open a well-described GitHub Issue
  • Security Vulnerabilities — Refer to SECURITY.md
  • License Agreement — Contributions are under GPL-3.0

Fix typo: "Git Hub" → "GitHub"


2. Fix README.md

The README has outdated copy, typos, and formatting issues. Fix:

  • Line 3: Remove "SlowGuardian will continue development on September 1st, 2024" — this is outdated and irrelevant for release
  • Line 5: Fix typo "powerd""powered"
  • Lines 40–42: Fix the Updating section — it's missing a newline and the code blocks are malformatted. Should be:
    ### Updating
    ```bash
    cd SlowGuardian
    git pull --force --allow-unrelated-histories
    
  • Lines 46–47: The all-caps Replit notice is no longer relevant (Replit is discontinued per the note itself). Clean it up or remove it.
  • Lines 49–52: The "Introducing Developer Info!" section title should use ## not # to maintain hierarchy. Fix "preformance""performance".
  • Lines 54–58: The "UPDATE INSTRUCTIONS" heading should use ##. Remove the reference to "Shell tab of your Repl" (Replit is discontinued).

3. Fix index.js — Multiple Bugs and Issues

Bug: import after var declarations (ES module ordering issue)

Line 16 has import readline from "readline" placed after var declarations. All import statements must be at the top of an ES module file. Move import readline from "readline" to the top with the other imports.

Bug: Typo in string "update avalible""update available" (lines 44 and 62)

Bug: Missing space separators in the db string builder

Lines 46, 50, 52 are missing leading | separators, making the output unreadable:

  • "| server uptime:"" | server uptime: "
  • "serverid: "" | serverid: "
  • "server identity: "" | server identity: "

Bug: Version comparison uses == with parseInt loosely (line 118)

if (v == parseInt(data))v is from config.version. Use strict comparison: if (parseInt(v) === parseInt(data)) or ensure types match with ===.

Bug: Auth middleware is registered AFTER routes (lines 155–185)

The auth middleware app.use(basicAuth(...)) and the custom auth handler are set up after all routes are already registered (lines 21–95). This means the auth check never applies to routes because Express middleware runs in order. Move the auth block to before the routes registration block.

Code quality: Replace var with const/let

Replace all var declarations with const or let as appropriate:

  • var vconst v
  • var updlet upd
  • var serveridconst serverid
  • var dblet db

4. Fix static/index.html — UI Issues

Issue: Broken particles.js script tag

Line 49–52: <script rel="preload" src="https://cdn.jsdelivr.net/particles.js/2.0.0/"></script>rel is not a valid attribute on <script> tags. Change to a proper <link rel="preload"> tag if needed, or load it correctly as a script. The CDN URL also needs to point to the actual JS file. Fix to:

<script src="https://cdn.jsdelivr.net/npm/particles.js@2.0.0/particles.min.js"></script>

Issue: Excessive/redundant ads cluttering the UI

The homepage has 7+ ad units including duplicate side banners and multiple stacked bottom ads, all using the same ad slot ID 7329110811 in multiple places. This likely violates AdSense policies (duplicate ad slots) and makes the UI unusable. Consolidate to a reasonable set:

  • 1 top banner ad
  • 1 in-content ad (after search)
  • 1 bottom banner ad
  • Remove the fixed side banner ads (left and right) — they overlap the main content on smaller screens and use duplicate slot IDs
  • Remove redundant duplicate bottom ads

Issue: <xn> is not a valid HTML element

Line 54: <h1 class="title"><xn>Slow</xn>Guardian</h1><xn> is not a valid HTML element. If it's used for styling, replace with <span class="highlight">Slow</span>Guardian.

Issue: Missing X-Frame-Options meta header

Other pages have `<meta http-equiv="X-Frame-Options" content="SAME...

This pull request was created from Copilot chat.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
algebra Ready Ready Preview, Comment Feb 23, 2026 0:13am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants