In: , , ,
On: 2013 / 03 / 29 Viewed: times
Shorter URL for this post: http://ozh.in/w2

As soon as YOURLS 1.6 ships, I'll move the project development from Google to Github (why? long story short: read this). So, I wrote down a little todo list to make sure the transition is as smooth as possible for everyone, which is:

On Github

  • Move in issues and tickets from Google. I wrote a tool for this
  • Move in wiki documents from Google. There are a few tools around, like wikiconvert.py, but in worst case scenario doing it by hand is an option.
  • Neatly organize the wiki on Github with a home page, sidebar, header and footer. Everything is explained in this article.
  • Make a custom CONTRIBUTING.md with a few guidelines (aka RTFM). This one is a very comprehensive start.
  • Create labels for issues: I was thinking bug, enhancement, duplicate, invalid, wontfix, RTFM, PEBKAC, worksforme, possiblewithaplugin.
  • Tag older commits in Git to recreate the same download list as in the original project
  • Maybe clarify the dev and branch strategy, such as in Zenphoto-Development-Process

On Google

Simply mention that the project has moved: modify issues, frontpage and wiki with the adminTabs feature at http://code.google.com/p/YOUR-PROJECT/adminTabs. Example.

Misc downloads

The inability on Github to host files other than your source code bugs me. In YOURLS there are a couple extra files that are available for download, or images used in the wiki documents.

So far the idea I've come up with is: create a branch named downloads and commit those little files there.

And?

Am I missing something? Any idea welcome :)

Shorter URL

Want to share or tweet this post? Please use this short URL: http://ozh.in/w2

Metastuff

This entry "Checklist for moving a project from Google Code to Github" was posted on 29/03/2013 at 6:39 pm and is tagged with , , ,
Watch this discussion : Comments RSS 2.0.

3 Blablas

  1. 1
    Matt Rude United States »
    replied, on 30/Mar/13 at 12:39 am # :

    As far as wiki images go, just add them to your wiki repo as you would any other file from your local computer, and push the changes to github. You will be able to view the images on the wiki by linking to it as you would any other image in Markdown (![Image Text](images.png). The files live at and may be accessed at https://raw.github.com/wiki/username/project/image.jpg so you may be able to store other for download using the same method, without cluttering up your main repository.

  2. 2
    Ozh »
    said, on 30/Mar/13 at 1:03 am # :

    Matt Rude ยป Interesting tip, thanks!

  3. 3
    Derek S United States »
    commented, on 15/Apr/13 at 9:57 pm # :

    I know a lot of projects use Github Pages: http://pages.github.com/

Leave a Reply

Comment Guidelines or Die

  • HTML: You can use these tags: <a href=""> <em> <i> <b> <strong> <blockquote>
  • Posting code: Post raw code (no <> &lt; etc) within appropriate tags : [php][/php], [css][/css], [html][/html], [js][/js], [sql][/sql], [xml][/xml], or generic [code][code]
  • Gravatars: Curious about the little images next to each commenter's name ? Go to Gravatar.
  • Spam: Various spam plugins on patrol. I'll put pins in a Voodoo doll if you spam me.
  • I will mark as Spam test comments, all comments with SEO names (ie "My Cool Online Shop" instead of "Joe") or containing forum-like signatures.

Read more ?