Skip to content

Consider adding cursor rules to the repo for better contribution #16031

@raythurnvoid

Description

@raythurnvoid

Describe the problem

It would help maintaining consistency and make the AI aware of how the repo is structured and eventually gotchas when modifying certain parts

Describe the proposed solution

It's possible to create the following rule files:

  • workflow-contributing-debugging.mdc: similar to CONTRIBUTING.md with the addition of steps to ease the debugging of svelte eg (link the svelte repo to a local folder to troubleshoot the resolution of a bug)
  • workflow-testing.mdc: how tests are structured, how to run them.
  • code-tests.mdc: patterns to follow when production or changing tests.
  • code-svelte.mdc: pattern to follow in the main code and performance considerations eg: let vs var.
  • code-reactivity.mdc: explaination on how the reactive system work and gotchas when changing it and performance tips
  • code-compiler.mdc: same as signal but for compiler stuff

The list can keep expanding and can touch all the LSP stuff and the CLI and the lints and you can just keep going.

Importance

nice to have

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions