6 ms·
Turning a side project into an open-source project
- jehna1 9y agoHey, I'm the author of this blog post. Hit me with questions if you got some!
- jehna1 9y agoTL;DR: how to turn a side project into an OSS side project: start by scratching your own itch, timebox tweaking, write a good README, hit publish. Easier than you'd think. here's the project https://github.com/jehna/ga-lite https://github.com/jehna/ga-lite
- mjleino 9y agoNice work! I especially appreciated the emphasis on writing a good README… but I think it's missing the most crucial thing you need on top your README. That's the motivation aka why the project exists at all, why it's better than the alternatives, etc.
- jehna1 9y agoThe differentiating qualities of the project is indeed very important. But I think it's more than okay to also say that "this is a clone of xxx I'm using to learn yyy".
- Jaxan 9y agoPutting a bit more into the README has my preference. Often I come acros repos with “I cloned xxx with yyy”, where I have never heard of xxx. It only takes a bit more to briefly explain xxx.
- CthulhuCoin 9y agoi love the idea of just finishing - anything - and doing another. this is the only way to go, in any endeavor. try, fail, learn, fix. repeat.
- jehna1 9y agoDeadlines are a bliss. They help you to both reduce the unnecessary, but also to fail faster. Sunken cost fallacy is a real thing even in side projects.
- orng 9y agoI think that adding a (permissive) license is the missing step from this "tutorial". If you want people to use your project you are going to need to give them permission to do so.
- jehna1 9y agoI agree that it's crucial to have a good license for your project to spread. But I think it's one of those things that takes a lot of mental effort when you do it the first time. Fortunately GitHub helps you quite a lot nowadays with choosing the license for your project.
- moron4hire 9y agoOnly because so much FUD has been spread about the GPL
- bluGill 9y agoThe GPL advocates say it is FUD, but as any BSD advocate will tell you the concerns are real. Note that GPL advocates spread FUD about the BSD license In my experience the GPL advocates completely ignore the concerns of the BSD people. The BSD people understand the GPL concerns they either don't think they are very real world (they will acknowledge some exceptions when forced to); or more pragmatically think that the GPL: concerns are outweighed by other concerns. You need to figure out where you stand. Calling the concerns of the other side FUD is in fact not helpful.
- vog 9y ago> Note that GPL advocates spread FUD about the BSD license. In my experience the GPL advocates completely ignore the concerns of the BSD people Um ... people who advocate for GPL are not a uniform group. > Calling the concerns of the other side FUD is in fact not helpful. I fully agree with that statement, though.
- ShaneCurcuru 9y agoYou have to have a license to attract contributors. https://choosealicense.com/ https://choosealicense.com/ and github make it easy; there's zero excuse to not have a license. Permissive licenses attract the broadest range of contributors, so if you're looking to build a large community, they are the way to go. GPL tends to have a smaller overall, but very strong pool of contributors, so if copyleft makes sense for your technology, by all means use it. Just use a license, please.
- spieglt 9y agoI was just worrying last night that I've released my side project too early, so glad to hear someone encouraging imperfect-but-usable releases. If anyone has advice on finding users, testers, and contributors besides posting on Show HN, please let me know. https://github.com/spieglt/flyingcarpet https://github.com/spieglt/flyingcarpet
- jehna1 9y agoWow, cool project! You should try Reddit. It has a lot of niche communities where you could share your project. Also Google for things someone who seeks for a project like yours would Google. That gives you a rough idea of what kind of sources people use to find tools like yours. Also some directories list specific tools (like "awesome" lists of github). Try listing your project there. Or even starting your own "awesome" list project on GitHub :)
- spieglt 9y agoThanks! Any specific subreddit recommendations besides r/golang?
- jehna1 9y agoTry product-specific subreddits like /r/coolgithubprojects There are other subreddits too which are trying to find cool projects like yours. Other approach is to write a blog post and post that to e.g. /r/opensource
- dovyski 9y agoAwesome, project! I can't even count how many times I needed something precisely like FlyingCarpet. Please spread the word about your project.
- spieglt 9y agoPlease help me! I'm trying but I've gotten next to 0 feedback so far. If you have two laptops will you test it and let me know what your experience was?
- joeblau 9y agoThis is a great guide. I followed the similar steps for https://gitignore.io https://gitignore.io I was doing a lot of development work and going to github.com/github/gitignore to copy templates from GitHub's website to my own file system was getting tedious. What I wanted was a simple command line tool like gi java > .gitignore So I built it over the course of a week while at Mammoth CA. I was on a snowboard trip so I would ride during the day and code at night. I was thankful to have a great designer (who worked at GitHub) help me design the site. And today the project is almost 5 years old and gets nearly 80,000 MAU's.
- onion2k 9y agoA little feedback - it seems a bit mixed up. If I put in "Node" it assumes I want suggestions for files that you'd typically ignore on a Node project. That's useful. But if I enter "Web" it gives me a list of web file types to ignore (*.html etc). Rather than assume I'm working on a web project (as it does for Node) it's doing the opposite of that, and making suggestions to ignore all the "Web" files. Clearly this isn't a huge problem as your project is doing really well, but it jumped out at me a bit.
- joeblau 9y agoThe history on this is that originally, templates like Web, Compressed, Audio, Video, etc... were added to ignore an entire domain's tele tapes instead of assuming that you're working on any of those types of projects. Right now, there isn't anything that differentiates the domain specific templates from a language, IDE, or operating system template. Not sure how to improve the experience off the top of my head but I'll think about it. Good feedback.
- _sdegutis 9y agoThis idea sounds like a good use for ‘choose’ [1]. It’d be a bash script that uses curl to get a list of the languages with gitignores, pipes to choose to let the user choose one, and pipes it into curl again to get the gitignore contents and sends to stdout. [1] https://github.com/sdegutis/choose https://github.com/sdegutis/choose
- jlg23 9y agoCall me old-fashioned, but the only thing necessary for turning a side project into open source is to grant anonymous access along with a license. Well, that, and either too much disposable time or a strict policy how to deal with users or contributors. Making this policy clear to your users/contributors is IMHO the most important thing - it allows you to tell people to GTFO if they disagree; after all, they already get more than they paid for.
- dawnerd 9y agoYep. Anything more and you’ve turned it into a side job that doesn’t pay.
- sudhirj 9y agoOn the subject of OSS projects on the side, I'm really interested in the dual licensing model - I'd like to have my code licensed under a strict copyleft license so people can see the code, but a more permissive license so businesses can use it. Based on articles like http://www.mikeperham.com/2015/11/23/how-to-charge-for-your-open-source/ http://www.mikeperham.com/2015/11/23/how-to-charge-for-your-... I've figured out the following: OSS license - AGPL - I'm building web services distributed as docker containers, so AGPL makes sense because it forces businesses to buy a license even if thy just deploy an instance of the service without modification. Commercial license - this is where I'm stuck. MIT / BSD isn't a good fit because the business is then free to make and sell their own version of the service. What license will allow a business to run my service, and customize it for their own needs if necessary, but not re-license or redistribute it? Based on https://choosealicense.com/appendix/ https://choosealicense.com/appendix/ it seems like the Mozilla Public License comes close, but it forces businesses to disclose the changes they've made - which I doubt they'd want to do. I don't want to write my own license - anyone know of a good existing license or template? Don't mind buying it if it's less than $100, but getting a lawyer to write one is much more expensive.
- bluGill 9y agoAGPL doens't force bushiness to buy a license. They can use your code at no cost and modify at will so long as they make their changes available AGPL. What you want is dual license. First is AGPL: you accept that some companies will use the free code - get over it. Second is a non-open source license: your lawyers write it, those who buy this license don't have to share changes (which could be made by you or them). The hard part is not the license, the hard part is the business model so you don't go bankrupt. Since AGPL is always available what do you offer so that a company will pay you? (there are many good answers, just make sure you have one)
- sudhirj 9y ago> AGPL doens't force bushiness to buy a license. They can use your code at no cost and modify at will so long as they make their changes available AGPL. Because the AGPL counts network access as distribution, it would force businesses to open source their private codebases that communicated with my service - which is enough of deterrent to freeloading for me.