GerardWalsh
commented
5 years ago Now the glossary is a good idea! Onto this today
On Tue, May 28, 2019 at 6:03 PM Andrew Collier notifications@github.com wrote:
Hi @gerrywalsh https://github.com/gerrywalsh,
Nice start on this document.
I think that it would make more sense to divide it up into sections like
(1) Creating branches (mostly done but mention feature branches here) (2) Connecting to a remote repository (3) Pushing/Pulling (4) Merge requests
You've got a similar structure but I think it would be helpful to more clearly define these sections, because reading through your content there's some leakage between sections. Try to keep each as clean and self-contained as possible.
Also where there are distinctions in terminology ("pull request" versus "merge request") it makes sense to mention them. You've done this already, but this should go into the appropriate section and maybe you could create a sub-section called "Terminology". In fact, might make sense to have a glossary at the top of the document where you just define terms?
Good work!
- Andrew.
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/datawookie/www-exegetic-biz/issues/36?email_source=notifications&email_token=AGDY3I752EM6H7KSBIR6AILPXVJUPA5CNFSM4HQE4QGKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4GWITG3Q, or mute the thread https://github.com/notifications/unsubscribe-auth/AGDY3IZAR5WKPZSCV4E6HATPXVJUPANCNFSM4HQE4QGA .
datawookie
Hi @gerrywalsh,
Nice start on this document.
I think that it would make more sense to divide it up into sections like
(1) Creating branches (mostly done but mention feature branches here) (2) Connecting to a remote repository (3) Pushing/Pulling (4) Merge requests
You've got a similar structure but I think it would be helpful to more clearly define these sections, because reading through your content there's some leakage between sections. Try to keep each as clean and self-contained as possible.
Also where there are distinctions in terminology ("pull request" versus "merge request") it makes sense to mention them. You've done this already, but this should go into the appropriate section and maybe you could create a sub-section called "Terminology". In fact, might make sense to have a glossary at the top of the document where you just define terms?
Good work!