search

rorybyrne / git-plan

Git Plan - a better workflow for git
MIT License
181 stars 5 forks source link

The plan directory should not be in `.git/` #61

Closed rorybyrne closed 3 years ago

rorybyrne commented 3 years ago

Maybe .plan/ will be better?

.plan
├── EDIT_TEMPLATE
├── PLAN_TEMPLATE
├── plans
       └── commit-1616487506.txt
Stedders commented 3 years ago

I was looking at this a little last night with regards to https://github.com/synek/git-plan/issues/45.

Where would you expect .plan to live?

I started thinking that we should set up an area in the user's home drive. We could use a .local or .config folder in the user dir to store it as mentioned here.

~
├─.local
       ├─git-plan
                ├─templates
                    └── EDIT
                    └── PLAN
                    └── CLIENT-EDIT (custom)
                ├── plans
                    └── commit-1616487506.txt
                ├── config.yml
rorybyrne commented 3 years ago

I was thinking that .plan/ would be in the repository root directory. Each project has its own .plan/. The benefits are 1) planfiles are stored in-project, which is clean and safe, and 2) template files can be committed to source control if teams want to share them. One disadvantage is that teams would have to put .plan/plans in their .gitignore instead of the cleaner .plan/, but for me that's not a big deal.

We can also support .local/ level templates, and load the template with a priority like in-project > local > default.

Edit: We could support both local- and project-level config.yaml similarly

rorybyrne commented 3 years ago

Heads up @Stedders:

I closed this in #69

Also, maybe we should use .config/git-plan to store per-user configuration files (templates and config.yaml). That's the recommended place for it, as far as I know?

Stedders commented 3 years ago

Hey @synek, agreed. That was my intention with the custom plans.

I've been a bit tired up with stuff this week, but I will try to raise a PR including a ~/.comfig structure on Sunday.

rorybyrne commented 3 years ago

No worries, take your time. Looking forward to seeing the PR.

I'm going to put some thought into #63 because it unlocks future functionality, and I'll also get #67, #70, and #66 done over the weekend.

rorybyrne commented 3 years ago

Also while I have you @Stedders I renamed master to main because I kept mis-typing it. Sorry for the hassle.