Releasing something to the community? Good for you, and good for the community! Seriously.
However, there are some things that people who release themes, scripts, code snippets, and whatnot really need to learn. I’m not whining here, it’s great that you’re taking the time to share with everybody, but you’ll see that it’s a lot more appreciated if you do it properly, and you won’t get so many stupid questions.
The Release Checklist
Please make sure that you’ve got these points covered, before tooting the horn and releasing your work of brilliance:
- Zipped up and ready to go? Not until you’ve uploaded it to your server/host, and then downloaded it and tested it. Too many scripts and themes have lost something in the upload, or maybe it never ended up in the zip in the first place.
- Always include a readme with instructions! Go through the install phase, and tell me how to use your project, and what I can do with it.
- Please make sure that links to your site, licenses, and things like that are available in the package.
- Are you offering support on your project? How? When? Where? If you know you won’t let me know, I won’t begrudge you, but if you tell me that you’ll fix things at a day’s notice, and it’s been three months since the release, then I won’t be happy.
- Whether you offer support or not, where should I go to find more help? This is probably a forum, a blog post, or something similar.
- Where will new versions be released? In blog posts on your blog (then I might want to subscribe to it), or on a dedicated page? The latter is preferred since it can get pretty messy otherwise, especially if I found your nifty little offering via a search engine.
- How do I upgrade? I need to know this, even if it’s just to overwrite the old version of your script.
Again, I’m not whining here, I think it’s great that there are people offering their hard work for free. Open source rocks, it really does.
However, the less I, as a user, will need to bother you, as a developer or designer, the better for both of us, right? Right. So take a moment to think about the things above, and we’ll be fine.
Carry on with your brilliance!