HTMLHint/.cursor/rules/general.mdc at 6f6ff23451de25d9faa612f433eb934b42bceb59 · htmlhint/HTMLHint · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
---
description: General rules for the project
globs:
alwaysApply: true
---

- When adding a new rule to website ensure that it has the frontmatter: `pagefind: false   sidebar:   badge: New  hidden: true`.
- Always run `npm run lint` before declaring that a task is complete (if you've changed any files).
- Always use lf for line endings.
- Code is formatted with prettier.
- As a general rule, rules should be listed alphabetically.

## GitHub Actions

- The GitHub Actions workflows should be placed in the .github/workflows directory.
- The workflows should be named `<workflow-name>.yml`.
- All GitHub Actions should be pinned versions to avoid breaking changes (SHA-1).
- If using actions/checkout, it should have `persist-credentials: false` set.

## Documentation

- All documentation should be written in US English.
- For the 'Why this rule is important' section, always include a link to the relevant documentation and prefer MDN and Google documentation along with official documentation from the W3C.