RFR: 7903693 Add contribution guidelines section

[Jonathan Gibbons]

On Mon, 11 Mar 2024 12:46:11 GMT, Ludvig Janiuk <lujaniuk at openjdk.org> wrote:

> Adding in `building.md` as it seems the place one would read if making changes.

Thanks for the contribution.

One suggestion and one typo. Please fix before integrating.

doc/building.md line 150:

> 148: One notable exception is the rule about case-sensitivity - jtreg's command line
> 149: flags are case insensitive and due to backwards compatibility it seems 
> 150: reasonable to keep this going forward.

Yes, we should specify the case we encourage folk to use, but permit case-insensitive matching.

doc/building.md line 150:

> 148: One notable exception is the rule about case-sensitivity - jtreg's command line
> 149: flags are case insensitive and due to backwards compatibility it seems 
> 150: reasonable to keep this going forward.

Generally, it is good practice to not use time-dependent text, like "going forward", in any spec. 

I would replace the entire 148-150 lines with,

For backwards compatibility, `jtreg` option names are case-insensitive.

doc/building.md line 153:

> 151: 
> 152: The jtreg codebase is very dependend on (jtharness)[https://github.com/openjdk/jtharness]. 
> 153: The two respos should most often be viewed together. This also places constraints 

typo: `respos`

-------------

Marked as reviewed by jjg (Lead).

PR Review: https://git.openjdk.org/jtreg/pull/192#pullrequestreview-1937877048
PR Review Comment: https://git.openjdk.org/jtreg/pull/192#discussion_r1525589747
PR Review Comment: https://git.openjdk.org/jtreg/pull/192#discussion_r1525591874
PR Review Comment: https://git.openjdk.org/jtreg/pull/192#discussion_r1525589184