CJ-Systems / gitflow-cjs

CJS Edition of the git extensions to provide high-level repository operations for Vincent Driessen's branching model
http://nvie.com/posts/a-successful-git-branching-model/
Other
92 stars 12 forks source link

Should we create a set of man pages for git flow commands with brief explanations of options for new users? #2

Open ChrisJStone opened 1 year ago

ChrisJStone commented 1 year ago

Write documentation for git flow that can be installed along with git flow

paulwwisl commented 1 year ago

Isn't there https://github.com/danielkummer/git-flow-cheatsheet ?

ChrisJStone commented 1 year ago

Isn't there https://github.com/danielkummer/git-flow-cheatsheet ?

Thank you for the repo link, I do have it in the project README. Most of the cheat sheets I have found seem assume some level of proficiency with git.

When I initially created this issue I was thinking along the lines of providing a set of man pages that could be installed along with git-flow itself. That way some one new to git could look at the man page for the particular command and see the available flags and a brief description of what they do. That way a new user could get a basic idea of what some of the advanced options do and not have to look up the option in the git manual just to find out what it does.