Proposal: UPSTREAM.md -- better tracking of upstream code in the JDK

[Jonathan Gibbons]

Putting these markdown files amongst the *.java and other kinds of 
source files seems wrong.

I like the idea of a standardized file in a standard place, but maybe it 
would be better per-module, in `src/<module>/UPSTREAM.md` and contain a 
relative path to the root of the upstream files in that module. All with 
suitable accommodation when a module has multiple upstream components. 
Variants might be `src/<module>/UPSTREAM-<component>.md` or 
`src/<module>/upstream/<component>.md`.

-- Jon

On 4/21/22 11:58 AM, Magnus Ihse Bursie wrote:
>
> My suggestion is that we add a file, UPSTREAM.md, in the top directory 
> of the imported 3rd party code. These files will follow a pattern, 
> with a set of formalized headers on the top, a blank line of 
> separation, and then a free-form markdown text, with e.g. relevant 
> notes about the project, important information about the latest 
> update, or instructions or hints on how to update the source to a 
> newer version.