gitreflow icon indicating copy to clipboard operation
gitreflow copied to clipboard

Workflow Documentation Request

Open ahmadawais opened this issue 9 years ago • 4 comments

As embarrassing as it may sound. This repo is the first time I got to hear about LGTM reviews. But the point is, I am always trying to improve on things like my workflows.

Which is why, I am requesting a WIKI document, that explains how does your workflow work. Nothing too complex just one example where you would use Git Reflow and show us how it will work with LGTM in an explicit example.

It will help a lot.

ahmadawais avatar May 27 '16 21:05 ahmadawais

@codenamev Perhaps a README is not enough, do you have any ideas? I'd be happy to take on this task.

simonzhu24 avatar May 30 '16 04:05 simonzhu24

@codenamev Looking forward!

ahmadawais avatar Jun 17 '16 11:06 ahmadawais

I think you're looking for something like this? https://github.com/thoughtbot/guides/tree/master/protocol/git

@simonzhu24 would you mind porting that to our workflow?

codenamev avatar Jun 17 '16 12:06 codenamev

The link above is stale; last version on that path in that repo was https://github.com/thoughtbot/guides/tree/d7e06ad3bf775b456d703537d34db6c33dc0222f/protocol/git and the guides have been reorganised ("to avoid duplicating content") so their git content is now under https://github.com/thoughtbot/guides/tree/master/git

They've also removed the Best Practices section, so this stuff

  • Avoid merge commits by using a [rebase workflow].
  • Squash multiple trivial commits into a single commit.
  • Write a good commit message

is maybe no longer so strong within thoughtbot

sesam avatar Oct 14 '20 07:10 sesam