search

serokell / coffer

Multi-backend password store with multiple frontends
4 stars 2 forks source link

Supported `view` command by default #8

Closed DK318 closed 2 years ago

DK318 commented 2 years ago

Resolves #3

MagicRB commented 2 years ago

The commit should be something akin to 

[#3] Support view command by default

Problem:

Solution:

the problem/solution part may be unnecessary as it's such a simple change and the problem/solution texts on these commits generally end up being X is missing. Add X.

dcastro commented 2 years ago

The commit should be something akin to

Absolutely.

the problem/solution part may be unnecessary as it's such a simple change and the problem/solution texts on these commits generally end up being X is missing. Add X.

Nevertheless, it's still good practice to get in the habit of doing this.

Keep in mind that the "problem" section isn't necessarily just the fact that x is missing. It should also explain why x is needed in the first place. Why are we making view the default command? Why is that necessary? What root problem does that actually solve for the user (or someone else)? Every commit should have a clear purpose.

Sometimes this is already described in the corresponding github issue, so using that as a reference for your "Problem" section is a good starting point.