Open-Source-Chandigarh/VOCAB-VOYAGE----E-learning-website

[Code Quality & Accessibility] Remove commented code, add meta descriptions, and improve image accessibility

Aberta

#25 aberto em 21 de out. de 2025

Ver no GitHub
 (1 comentário) (0 reação) (2 responsáveis)SCSS (12 forks)auto 404
hacktoberfesthacktoberfest2025

Métricas do repositório

Stars
 (1 estrela)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Description

This issue tracks three related improvements to enhance code quality, SEO, and accessibility of the VOCAB VOYAGE e-learning website.

Problems to Address

1. Code Cleanup 🧹

  • Problem: js/main.js contains 300+ lines of commented-out code and git merge conflict markers
  • Impact: Makes code difficult to read and maintain
  • Location: js/main.js (lines 1-300+)

2. Missing Meta Descriptions 🔍

  • Problem: All HTML pages have empty meta description and keywords tags
  • Impact: Poor SEO performance and search engine visibility
  • Affected Files: All 9 HTML pages (index.html, about.html, courses.html, contact.html, login.html, signup.html, team.html, testimonial.html, single.html)

3. Missing Image Alt Text ♿

  • Problem: Multiple images have empty alt="" attributes
  • Impact: Poor accessibility for screen readers and users with visual impairments
  • Affected Files:
    • courses.html - 12 course images
    • single.html - 2 images

✅ Proposed Solution

  1. Remove all commented code and merge conflict markers from main.js
  2. Add comprehensive documentation with clear comments
  3. Add descriptive meta descriptions to all HTML pages with relevant keywords
  4. Add meaningful alt text to all images for better accessibility

I am ready with the PR you can assign me this under Hacktoberfest labels.

Guia do colaborador

Direção de pesquisa
Inspecione `js/main.js` em busca de código comentado e marcadores de conflito de merge (linhas 1-300+). Em seguida, para cada um dos 9 arquivos HTML, adicione uma meta descrição descritiva e palavras chave. Por fim, adicione texto alternativo significativo a todas as imagens em `courses.html` e `single.html` (e a quaisquer outras imagens com alt vazio). Use a estrutura do projeto existente como referência.
Pilha de tecnologia
javascript
Domain
frontendweb dev
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85