I like the idea. On Sat, May 4, 2013 at 8:16 PM, Fabiano Engler <[email protected]> wrote: > Hi all, > > I have looked for some information on how web2py is developed and > maintained, I found some bits of info here and there but no single > document on the topic, hence I am proposing for one to be created, > making web2py more open to contributors, especially making it easier > for casual ones. > > Some projects have a file on the top level directory with this info, > along with README, LICENSE, VERSION, etc., I don't think there is a > standard for that, some projects call it HACKING, some README.Hacking, > linux kernel is very complete in this regard and has a several files: > MAINTAINERS > REPORTING-BUGS > Documentation/BUG-HUNTING > Documentation/CodingStyle > Documentation/HOWTO > Documentation/ManagementStyle > Documentation/SecurityBugs > Documentation/SubmitChecklist > Documentation/SubmittingDrivers > Documentation/SubmittingPatches > > Of course that would be an overkill for a project of this size but > taking a look into those files can provide a good insight of what I am > talking about, especially the HOWTO. > > I think the first question this file should answer is "Where do I > start?". Without such a file, the first thing I did was looking at > web2py website, there is no "developers" section, but there is a > "Contributors" one, looking there there is a list of contributors and > an agreement to be signed. OK, even if I sign it, what's next? Not > much else on the section. > > Going on with the exploration of the website, on the Documents section > there is nothing on this topic either. On the Download section there > is a clue, there is Developers column on the download where there are > links for two repositories, one on github and a mercurial one on > google code and a link to report bugs also on google code. > > Hum, getting closer, I know where I can submit bug-reports at least. > Looking at the project page on google code there is nothing on the > Wiki or Home section either. > > So I get two repos and some questions: > Should I use git or the mercurial one? Or it doesn't matter? > Do they get in sync? If so, how often? > Which repo/version/branch should I use to base patches on? > Where should I submit patches? Mailing list? Issues tracker? A > pull on github? > Where is the official trunk? > Is there a process of patch submission/review? > Is there any specific convention or style should I follow? > > > Do you guys think it would be valuable to have a file with this info? > I would certainly appreciate it as I hope in the future start to > contribute, it wouldn't need to be anything fancy, just a couple > paragraphs with directions for starters. > > I took a quick look to see what the Django Project had on this and > they have quite a comprehensive documentation for developers, to the > point they have a dedicated domain for it, code.djangoproject.com, > with a lot of useful information. Some examples from there are worth > taking a look: > > Django source-code repository, wiki and bug-report system > https://code.djangoproject.com/ > Getting the code > Browsing the code online > Getting involved > Tickets > Little, easy improvements > "Easy Pickings" Tickets > How to report security issues. > DjangoDesign > Branches > Descriptions of major changes to the codebase > Under discussion > More Django resources > > How to contribute to Django > https://docs.djangoproject.com/en/1.5/internals/contributing/ > Advice for new contributors > First steps > Guidelines > FAQ > Writing code > Coding style > Unit tests > Submitting patches > Working with Git and GitHub > > > Fabiano. > > -- > > --- > You received this message because you are subscribed to the Google Groups > "web2py-users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/groups/opt_out. > >
-- --- You received this message because you are subscribed to the Google Groups "web2py-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/groups/opt_out.
