[ DOCUMENTATION ]
Project rules
Teach Hearth how your project works with one plain Markdown file.
ON THIS SITE
Create a file called RULES.md at the root of the project. Hearth reads it at the start of every task.
What to put in it
How to run the tests. Which folders are generated and should never be edited. How you name branches and write commits. Any library you do not want used. Keep it short: ten to twenty lines is plenty.
Per-folder rules
A RULES.md inside a folder applies to that folder and everything under it. That is useful for monorepos where each package has its own conventions.
Create a file called RULES.md at the root of the project. Hearth reads it at the start of every task.
What to put in it
How to run the tests. Which folders are generated and should never be edited. How you name branches and write commits. Any library you do not want used. Keep it short: ten to twenty lines is plenty.
Per-folder rules
A RULES.md inside a folder applies to that folder and everything under it. That is useful for monorepos where each package has its own conventions.
Was this page helpful?
Yes
Not quite
