RFR: 8251552: Add minimal CONTRIBUTING.md file

Erik Helin erik.helin at oracle.com
Fri Aug 14 07:07:56 UTC 2020


On 8/14/20 8:56 AM, Robert Stupp wrote:
> There's a `Contributing` section at the end of doc/building.[md|html]
> with some more information. Maybe just copy/move that section to
> CONTRIBUTING.md?

I would prefer to not scatter documentation in multiple places, which is 
why I went for a minimal CONTRIBUTING.md file that just refers to 
existing documentation.

Thanks,
Erik

> On Fri, 2020-08-14 at 07:40 +0200, Erik Helin wrote:
>> On 8/13/20 11:11 PM, Iris Clark wrote:
>>> Hi, Erik.
>>
>> Hi Iris,
>>
>> thanks for reviewing!
>>
>> On 8/13/20 11:11 PM, Iris Clark wrote:
>>> Shouldn't CONTRIBUTING.md reference this link instead?
>>>
>>>       https://openjdk.java.net/contribute/
>>>
>>> It contains preliminary information for new people to begin making
>>> contributions to the JDK Project.
>>
>> I agree, that seems better than just linking to the developer's
>> guide.
>> Please see updated webrevs below:
>>
>> - full: https://cr.openjdk.java.net/~ehelin/8251552/01/
>> - incremental: https://cr.openjdk.java.net/~ehelin/8251552/00-01/
>>
>> On 8/13/20 11:11 PM, Iris Clark wrote:
>>> Perhaps I'm not understanding the audience for CONTRIBUTING.md?
>>
>> It seems like you understand it very well given your great feedback
>> in
>> this review :)
>>
>> Thanks,
>> Erik
>>
>>> Thanks,
>>> Iris
>>>
>>> -----Original Message-----
>>> From: Erik Helin
>>> Sent: Thursday, August 13, 2020 12:54 PM
>>> To: jdk-dev at openjdk.java.net
>>> Subject: RFR: 8251552: Add minimal CONTRIBUTING.md file
>>>
>>> Hi all,
>>>
>>> please review this patch that adds a minimal CONTRIBUTING.md file
>>> to the repository. Many source code forges (e.g. GitLab, GitHub,
>>> BitBucket) show the CONTRIBUTING.md file when a newcomer makes
>>> their first contribution. Since we already have an OpenJDK
>>> developer's guide [0], I've chosen to go with a minimal
>>> CONTRIBUTING.md file that only refers the reader to the developer's
>>> guide.
>>>
>>> Issue:
>>> https://bugs.openjdk.java.net/browse/JDK-8251552
>>>
>>> Webrev:
>>> https://cr.openjdk.java.net/~ehelin/8251552/00/
>>>
>>> Thanks,
>>> Erik
>>>
>>> [0]: https://openjdk.java.net/guide/
>>>
> --
> Robert
> 
> --
> Robert Stupp
> @snazy
> 


More information about the jdk-dev mailing list