Better README.md for dlang.org

Vladimir Panteleev via Digitalmars-d digitalmars-d at puremagic.com
Tue Jan 20 13:36:01 PST 2015


On Tuesday, 20 January 2015 at 16:34:33 UTC, H. S. Teoh via 
Digitalmars-d wrote:
> On Tue, Jan 20, 2015 at 08:24:29AM -0800, Andrei Alexandrescu 
> via Digitalmars-d wrote:
>> On 1/20/15 2:19 AM, Andrej Mitrovic via Digitalmars-d wrote:
>> >On 1/20/15, Andrei Alexandrescu via Digitalmars-d
>> ><digitalmars-d at puremagic.com> wrote:
>> >>https://github.com/D-Programming-Language/dlang.org/blob/master/README.md
>> >>
>> >>1. If instructions don't work for you, reply here.
>> >>
>> >>2. Additions for Windows would be welcome. FWIW I think the 
>> >>Windows
>> >>makefile suffers from a bit of bitrot.
>> >
>> >Btw, apparently we can use a contributing file that 
>> >automatically
>> >shows up when people make pull requests:
>> >
>> >https://help.github.com/articles/setting-guidelines-for-repository-contributors/
>> 
>> Shall we move README.md to CONTRIBUTING.md then? -- Andrei
>
> We should have both. The current README.md should explain what 
> the repo
> is all about. Details on contributing should go in 
> CONTRIBUTING.md.

Case in point, this occurred on IRC today:

[2015-01-20 21:25:09] [dgiagio] Where can I open an issue for 
druntime? It's GitHub repo doesn't support opening issues

There should probably be a link to Bugzilla in every repo's 
README.md. So many projects on GitHub use GitHub issues 
(including e.g. Rust) that some people might head directly there 
to file an issue.


More information about the Digitalmars-d mailing list