Skip to content

HTML code quality #153

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
11 tasks done
blahosyl opened this issue Aug 16, 2024 · 0 comments
Closed
11 tasks done

HTML code quality #153

blahosyl opened this issue Aug 16, 2024 · 0 comments
Assignees
Labels
e: code quality Epic: Code quality p: must have Priority: Part of the MVP

Comments

@blahosyl
Copy link
Owner

blahosyl commented Aug 16, 2024

As a Developer,

I want my HTML files to be well-structured and -commented,

so that my code is easy to audit and maintain

Acceptance Criteria

  1. All self-written HTML files in the project have inline comments explaining areas that require particular attention or have proven to be common stumbling blocks
  2. All self-written HTML files in the project are organized into logical and well-commented blocks
  3. All self-written HTML files in the project have commented-out code removed
  4. Comment coverage errs on the side of "more is more", as befits a neurodivergent coder's first-time Django project.
  5. The W3C HTML validator finds no errors on the rendered pages.

Commenting

  • index.html

Validation

  • landing page
  • signin page
  • # page
  • task kanban page
  • task list page
  • task detail page
  • task create page
  • task edit page
  • profile list page
  • profile detail page
@blahosyl blahosyl self-assigned this Aug 16, 2024
@blahosyl blahosyl moved this to Backlog in Task Manager Aug 16, 2024
@blahosyl blahosyl changed the title HTML comment coverage & structure HTML comment code quality Aug 16, 2024
@blahosyl blahosyl added p: must have Priority: Part of the MVP e: code quality Epic: Code quality labels Aug 16, 2024
blahosyl added a commit that referenced this issue Aug 18, 2024
@blahosyl blahosyl moved this from Backlog to In Progress in Task Manager Aug 18, 2024
@blahosyl blahosyl changed the title HTML comment code quality HTML code quality Aug 18, 2024
blahosyl added a commit that referenced this issue Aug 19, 2024
@blahosyl blahosyl moved this from In Progress to Done/Won't do in Task Manager Aug 19, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
e: code quality Epic: Code quality p: must have Priority: Part of the MVP
Projects
Status: Done/Won't do
Development

No branches or pull requests

1 participant