Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a pick Recipes page, maybe as part of the Wiki #145

Open
kylebebak opened this issue Jul 2, 2016 · 11 comments
Open

Create a pick Recipes page, maybe as part of the Wiki #145

kylebebak opened this issue Jul 2, 2016 · 11 comments

Comments

@kylebebak
Copy link

pick is really awesome, in less than a month it's become a great friend to me. It makes working with git branches and commits a lot easier, but maybe I wouldn't have thought to use it like that if I hadn't seen the gif in the README.

My point is that pick is a versatile tool whose possibilities aren't necessarily obvious at first. I think having a Wiki-style section for Recipes could bring in creative, cool use cases, and give new users more ideas of how to use pick.

I wrote a post about how I use it with git, I basically wrote some helper functions that wrap pick to make operations with branches and commits very fast.

This is the kind of stuff I think could go into Recipes, snippets of code using pick and gifs showing them in action. If this seems like a good idea I would love to contribute.

@calleluks
Copy link
Collaborator

Hey @kylebebak, thanks for the feedback and for writing a great blog post!

Here's a similar post that @mike-burns and I wrote when we announced Pick on the thoughtbot blog: https://robots.thoughtbot.com/announcing-pick

I think a Recipes page or section in the Wiki is a great idea for collecting these in one place, and would love to review your contributions!

I'm not super-familiar with the Wiki feature of GitHub. Is it possible for you to propose changes to the Wiki in some way?

@mike-burns
Copy link
Collaborator

I'd also be interested in a package that I can install that gives me these recipes.

@kylebebak
Copy link
Author

kylebebak commented Jul 11, 2016

@calleerlandsson @mike-burns

I found a gist with a workflow that would allow you to Merge Wiki Changes From A Forked Github Repo

In short, there's no way for a contributor to make a pull request for changes that only affect the wiki. Instead, the contributor pushes changes to his fork of the wiki repo, a repo that depends of the main repo but is sort of separate from it. He then sends you guys a link to his fork of the wiki repo, you review the changes, pull them to your clone of the main wiki repo, and push them to the main repo.

Sort of cumbersome, but it looks like the only way for you to have control of what gets committed to the wiki. If this sounds OK, I'd be glad to propose an initial version of the recipes page like this.

P.S.
Right now, I think anyone can edit the wiki on by going to https://github.com/thoughtbot/pick/wiki. I just created a test page and then deleted it. But I can't push changes from my clone of the wiki repo to the remote wiki repo: Permission to thoughtbot/pick.wiki.git denied to kylebebak.

This page says by default only collaborators can edit the wiki, which is weird, because I had no problem creating the test page.

@mike-burns
Copy link
Collaborator

@kylebebak if you can just directly edit the wiki for thoughtbot/pick, that'd be best.

@mptre
Copy link
Owner

mptre commented Jul 12, 2016

Can a file in this repository be used instead? This way all changes will
go through our usual PR-workflow.

@mike-burns
Copy link
Collaborator

Sure, that seems fine too. Even a PR against the README.md will be a great start.

@kylebebak
Copy link
Author

@mike-burns @mptre

Sorry for disappearing, I'll get on this over the weekend and make a PR against the README. The wiki is just a glorified README anyway. It might also make sense to put the recipes in a separate file and link to it from the README, if you don't want the README getting cluttered. Let me know how you prefer it.

I can write a package wrapping the Git tools and make it installable via Homebrew. I don't know about distribution on Linux and Windows, but I could certainly learn =)

Thanks all!

@calleluks
Copy link
Collaborator

I think a README section would be a great start. If it gets unwieldy, we can always extract it into a separate file later.

Thanks for working on this @kylebebak!

@kylebebak
Copy link
Author

Hey guys, sorry for disappearing again...

I wanted to contribute something useful and @mike-burns got me thinking that a package for these tools would be better than just a recipes page, so I wrote pick-git.

It's a Python 2/3 package installable via pip that works on OSX and most flavors of Linux. The README gives a rundown of functionality and explains how to get it set up. I would be really happy if you guys tried it out for yourselves and told me what you think!

Again, sorry for taking so long to get back on this, and thanks for writing pick. I've been loving the the vertical scroll you added in 1.5 =)

@calleluks
Copy link
Collaborator

Hey @kylebebak, I'm happy you've found a way to improve your workflow with pick!

I'm currently using gitsh for most of my git work but will try pick-git out when I get a chance.

@kylebebak
Copy link
Author

Thanks @calleerlandsson for pointing me towards gitsh. It's much more general-purpose than pick-git, but I imagine pick-git would be a useful complement for tasks involving branches, commits, and files.

Thanks also for giving it a try when you have time, I look forward to getting some feedback. Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants