Best practice on handling PLAN.md?

[0xbentang]

By default it just writes to project root, and it'll be easily overwritten by different PRs. Is it the intended use case and the purpose is to review the plan in PRs?
For now I just see it as a noise so I have a global ~/.gitignore to ignore it...not sure if this is recommended.

[backnotprop]

The plan is used to help guide you and help you iterate on what exactly you want developed and how you want it developed.

I then think it also becomes a nice artifact for the agent to use throughout implementation. This becomes more important the more effort the agent has to do. This is less important, the smaller the scope of work is.

The same can be said for reviews. I have started to stick the plan inside of my reviews. I'm figuring out how to do this as a native capability in plannotator. still unsure of a reliable way for all users.

I don't think you need to put plans inside the repo; it depends on your process.

• Claude Code has a home directory so these stay out

What harness do you use? You should be able to configure where the plans go

[0xbentang]

The plan is used to help guide you and help you iterate on what exactly you want developed and how you want it developed.

I then think it also becomes a nice artifact for the agent to use throughout implementation. This becomes more important the more effort the agent has to do. This is less important, the smaller the scope of work is.

Totally agree it is useful throughout development

The same can be said for reviews. I have started to stick the plan inside of my reviews. I'm figuring out how to do this as a native capability in plannotator. still unsure of a reliable way for all users.

This is the question: how can you put it to reviews without commiting the file? I guess you leave it unstaged locally on the repo while using plannotator to review? Or just put outside repo and review separately using annotate file feature? Or should we add a feature in review to add any files (or limit to only the plan file, I didn't read the code but if it's a configurable path you should have it somewhere in the system already?)

• Claude Code has a home directory so these stay out

What harness do you use? You should be able to configure where the plans go

I use pi. I think the current workaround is either a global .gitignore or just configure it outside the repo?

[backnotprop]

Or should we add a feature in review to add any files (or limit to only the plan file, I didn't read the code but if it's a configurable path you should have it somewhere in the system already?)

This is probably the best next version /simplest thing to ship. Otherwise, there are some things that aren't really intuitive when trying to figure out the right plan to automatically add to a review. All plans are always stored at ~/.plannotator/plans and I could ask the agent to just search there... But I think a more intuitive path is going to be some smart linking between the files and current sessions.

I use pi. I think the current workaround is either a global .gitignore or just configure it outside the repo?

You can run the below.. But I will ship an update to allow you to set a global directory so you don't have to worry about .gitignore