www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - Contributing

reply "Pedro Rodrigues" <pdfrodrigues gmail.com> writes:
Hello!

While working on some pet project using D 2.0, I stumbled on a Phobos module 
poorly documented (std.date). I had to check the source code to understand 
what was going on.
This made me think, I could help the next guy that stumbles on the same 
problem, by writing the missing documentation myself. Unfortunately I 
couldn't figure how am I to submit my contributions.
So I was wondering what is the preferred way (if any) to contribute to the D 
project? And I would also like to suggest a development model, like in 
github, where anyone can fork the project, and work on his fork. Then the 
maintainer of the main fork, can easily merge in the work done in other 
forks, if it pleases him. I believe this would make a lot easier to 
contribute to the project.

Cheers
Aug 16 2010
next sibling parent reply Adam Ruppe <destructionator gmail.com> writes:
I started doing this too, and am planning to commit it for the next
release. I haven't finished it though.

If you email your modified copy of date.d to me (destructionator (at)
gmail.com), I'll integrate your changes with mine and commit it to
Phobos for you.
Aug 16 2010
next sibling parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
Adam Ruppe wrote:

 I started doing this too, and am planning to commit it for the next 
 release. I haven't finished it though.
 
 If you email your modified copy of date.d to me (destructionator (at)
  gmail.com), I'll integrate your changes with mine and commit it to 
 Phobos for you.


There seems to be growing interest in std.date and the embryonic
std.gregorian as of late. Allow me to paste something I wrote to the
phobos dev list:


 Thanks for your work, Jonathan. Our decision after the issue with
 Tango's date and time was to use Boost's. I'd started std.gregorian
 as a seed of a port of Boost's date and time, in the hope that
 someone will continue it. Jeff Garland (Boost's date/time author) has
 been very supportive in the matter.
 
 I very strongly suggest to stick with copying Boost's or C++0x's date
 and time facilities, unless we find some clearly superior ways
 facilitated by D's features. Developing our own date/time library
 from scratch risks of being at best just as capable as Boost/C++0x
 but guaranteed unfamiliar to everyone.


To further elaborate, dates and times are a simple enough topic that 
many people might try their hand at designing. Yet today's designs did 
arrive at sufficient sophistication to prompt us to try copying a strong 
existing design instead of coming up with one from scratch.


Andrei
Aug 16 2010
prev sibling parent Adam Ruppe <destructionator gmail.com> writes:
On 8/16/10, Yao G. <nospamyao gmail.com> wrote:

 Are you working on Gregorian documentation? Or the code itself?


I've just been (slowly) documenting std.date. I used it for a work
project, and hit a similar situation to Pedro: the module was good
enough for me, but I had to dive into the source before I knew it even
had most the functions that it does.

The majority of them have nothing whatsoever, so they don't show up on
the website at all. Some of the others aren't obvious as to what the
return values mean. For example, do days of the week start at one or
zero? That kind of thing. If it were documented, I think it is
adequately fit.
Aug 16 2010
prev sibling parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
Pedro Rodrigues wrote:

 Hello!
 
 While working on some pet project using D 2.0, I stumbled on a Phobos 
 module poorly documented (std.date). I had to check the source code to 
 understand what was going on.
 This made me think, I could help the next guy that stumbles on the same 
 problem, by writing the missing documentation myself. Unfortunately I 
 couldn't figure how am I to submit my contributions.
 So I was wondering what is the preferred way (if any) to contribute to 
 the D project? And I would also like to suggest a development model, 
 like in github, where anyone can fork the project, and work on his fork. 
 Then the maintainer of the main fork, can easily merge in the work done 
 in other forks, if it pleases him. I believe this would make a lot 
 easier to contribute to the project.
 
 Cheers


Pedro,


Welcome and thanks for your intent to contribute. Discussing your ideas 
here, submitting patches to bugzilla (d.puremagic.com/issues), and 
creating and maintaining your own project on your website or at 
dsource.org should be enough to attract everybody's attraction.


Andrei
Aug 16 2010