Add .cursorrules file

[portdeveloper]

This PR introduces a .cursorrules file to enhance the development experience with Scaffold-ETH 2. The file contains:

• Instructions for answering Scaffold-ETH 2 related questions
• Important notes on using correct hook names (useScaffoldReadContract, useScaffoldWriteContract, these were used wrongly by AI as useScaffoldContractRead and useScaffoldContractWrite respectively)
• Example Q&As for common scenarios

I have read the documentation for prompt engineering on Claude.

And these were the steps:

1. Prompt generator - is sth online
2. Be clear and direct - tried with using clear verbs
3. Use examples (multishot) - gave two eamples
4. Let Claude think (chain of thought) - used the usual "think step-by-step" trick
5. Use XML tags - used them whenever possible to tell ai about important stuff or just to categorize
6. Give Claude a role (system prompts) - an expert in scaffold-eth 2
7. Prefill Claude’s response - didn't use this as answers might be different?
8. Chain complex prompts - didn't use it
9. Long context tips - the user doesn't use a long context by default?

To be honest, prompt engineering does not overlap with what a .cursorrules file is 100%. But I believe that using a .cursorrrules file such as this one makes sense as it improves how a newbie might interact with SE-2.

Also, the user might want to index se-2 docs, to better benefit from Cursor and also from the .cursorrules file, as we tell the LLM to check the docs as well.:

I believe the .cursorrules file can be improved on, and I would love to hear your feedback on this.

How to test

1. Clone the repo and switch to the branch.
2. Go to cursor settings and index se-2 docs
3. Open a chat
4. While asking your first question, please use CTRL+ENTER for windows and CMD+ENTER for macos for cursor to see all the files

[damianmarti]

@portdeveloper this looks good, I will try it. Is there a way to add the documentation link on the cursorrules file, so the user do not need to add this manually?

[portdeveloper]

@damianmarti Thanks!

I put it as a link there, but that way, the AI does not always read it.
I also tried putting docs in a single file here, and then putting it into the cursorrules file,
https://raw.githubusercontent.com/portdeveloper/crawl-se-2-docs/refs/heads/main/flattened_docs.md

But since it is looong, the AI again does not read it well. The only way here is to index it using Cursor's Docs feature.

[damianmarti]

@damianmarti Thanks!

I put it as a link there, but that way, the AI does not always read it. I also tried putting docs in a single file here, and then putting it into the cursorrules file, https://raw.githubusercontent.com/portdeveloper/crawl-se-2-docs/refs/heads/main/flattened_docs.md

But since it is looong, the AI again does not read it well. The only way here is to index it using Cursor's Docs feature.

ok, thanks!!

[portdeveloper]

I have been playing around with this .cursorrules file again and I think it might also make sense to ship this as an extension.

A file is still a file, and people might not want this weird file in their se-2 folders if they are not using cursor.

Also whatever I do, cursor sometimes do not care about the .cursorrules file.

I am thinking of putting the entire documentation locally inside se-2 in a llm-friendly format so that it can go and quote pieces of info from there.

The current problem we have is that the useScaffoldReadContract and useScaffoldWriteContract functions are ALWAYS used in a wrong way. Especially useScaffoldWriteContract. Cursor(or we should say Claude maybe) is ALWAYS WRONG with useScaffoldWriteContract.

[damianmarti]

I have been playing around with this .cursorrules file again and I think it might also make sense to ship this as an extension.

A file is still a file, and people might not want this weird file in their se-2 folders if they are not using cursor.

Also whatever I do, cursor sometimes do not care about the .cursorrules file.

I am thinking of putting the entire documentation locally inside se-2 in a llm-friendly format so that it can go and quote pieces of info from there.

The current problem we have is that the useScaffoldReadContract and useScaffoldWriteContract functions are ALWAYS used in a wrong way. Especially useScaffoldWriteContract. Cursor(or we should say Claude maybe) is ALWAYS WRONG with useScaffoldWriteContract.

I was using it while working on some SE-2 projects and like you said, it seems better with this file but not perfect.

I don't know if launching this as an extension is the best option, because then you can't use another extension if you want to add the cursor rules file.

I think we should keep iterating it, and when we are happy with it, add the file to SE-2 codebase or link the file from the README and/or documentation.

[portdeveloper]

Thanks for the feedback @damianmarti ! Could you please give it another go? I have made some changes to it and I would love to get feedback on them.