I think you should include the config file, but with example parameters and comments, point out in the readme that there are some basic configuration to be done
On Sun, Oct 14, 2012 at 9:59 PM, Cal Leeming [Simplicity Media Ltd] < cal.leem...@simplicitymedialtd.co.uk> wrote: > You could just include the necessary info in the README, or make a wrapper > script that does it for them - although I tend to stick with READMEs where > possible as they consume less time. > > If the code is coming straight out of production, there's a few tips I'd > recommended; > > * Ensure that you test the code outside of the production environment > against a test project, and make sure it works as expected. > * Triple check that you haven't left any private info in the code > * Provide a (reasonable) amount of documentation > > Personally, I tend to opt for this license; > http://en.wikipedia.org/wiki/WTFPL > > There are many places you can put your code (GitHub, my most favourite), > and others such as BitBucket and Google Code - again it's down to personal > preference. > > Here is an example of a project I open sourced a while back... at the time > I thought it was done well, but I later realised it needed a serious amount > of re-writing and documentation - which I still haven't got around to doing; > https://github.com/foxx/django-cutemodel > > Others may be able to offer a bit more advice, but the above is a head > start at least! > > Hope this helps! > > Cal > > On Sun, Oct 14, 2012 at 8:47 PM, Joshua Russo <josh.r.ru...@gmail.com>wrote: > >> I have project that I have been working and I was contemplating open >> sourcing it but I ran into a little hang up. How to handle the database >> authentication. The settings file obviously needs to be included but I >> don't want to advertise the production database login. How is this >> generally handled? >> >> Also, are there procedures that need to be followed to "properly" open >> source a project, or is it really just choosing a licence and dubbing it so? >> >> -- >> You received this message because you are subscribed to the Google Groups >> "Django users" group. >> To view this discussion on the web visit >> https://groups.google.com/d/msg/django-users/-/LJU31pYrcXgJ. >> To post to this group, send email to django-users@googlegroups.com. >> To unsubscribe from this group, send email to >> django-users+unsubscr...@googlegroups.com. >> For more options, visit this group at >> http://groups.google.com/group/django-users?hl=en. >> > > -- > You received this message because you are subscribed to the Google Groups > "Django users" group. > To post to this group, send email to django-users@googlegroups.com. > To unsubscribe from this group, send email to > django-users+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/django-users?hl=en. > -- You received this message because you are subscribed to the Google Groups "Django users" group. To post to this group, send email to django-users@googlegroups.com. To unsubscribe from this group, send email to django-users+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/django-users?hl=en.
