From mboxrd@z Thu Jan  1 00:00:00 1970
Subject: Re: [edk2-devel] [PATCH v1 2/6] ArmVirtPkg: Add Platform CI and configuration for Core CI
To: Laszlo Ersek <lersek@redhat.com>,devel@edk2.groups.io
From: "Sean" <sean.brogan@microsoft.com>
X-Originating-Location: Kirkland, Washington, US (50.35.74.15)
X-Originating-Platform: Windows Chrome 83
User-Agent: GROUPS.IO Web Poster
MIME-Version: 1.0
Date: Wed, 15 Apr 2020 13:38:03 -0700
References: <3e0cfe33-c972-9bdd-5db5-25c52a720823@redhat.com>
In-Reply-To: <3e0cfe33-c972-9bdd-5db5-25c52a720823@redhat.com>
Message-ID: <31845.1586983083124497540@groups.io>
Content-Type: multipart/alternative; boundary="q1kxoIWIM48Z8rCzEycN"

--q1kxoIWIM48Z8rCzEycN
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

On Wed, Apr 15, 2020 at 10:18 AM, Laszlo Ersek wrote:

>=20
> ArmVirtPkg/ArmVirtPkg.ci.yaml
> ArmVirtPkg/PlatformCI/Ubuntu-GCC5.yml
> ArmVirtPkg/PlatformCI/PlatformBuild.py
> ArmVirtPkg/PlatformCI/README-pytools.md
> ArmVirtPkg/PlatformCI/iasl_ext_dep.yaml

I am ok with the above except one thought on the readme.=C2=A0 One nice th=
ing about the markdown readme files are the badge shows up in github when y=
ou view the package.=C2=A0 This is a quick and easy way to see the current =
status.

* Ovmf has a pretty stale readme and does not take advantage of markdown.=
=C2=A0 =C2=A0 We could convert it to MD, clean up, and then merge in the c=
ontent from the pytools.md.=C2=A0 I would need help or a package maintainer=
 to do the cleanup of the readme to make sure it contained the content you =
desired.
* ArmVirtPkg doesn't have a readme and this is definitely a barrier to ent=
ry for the package.=C2=A0 I would suggest creating one and then merging in =
the content from the pytools.md.
* EmulatorPkg has one.=C2=A0 I would just suggest a merge but i am yet to =
get any feedback from those maintainers.

If that isn't desirable i would at least suggest we change the title to ju=
st ReadMe.md so that GitHub shows it by default when the PaltformCI folder =
is viewed form the web or in editor like vscode.

Thanks
Sean

--q1kxoIWIM48Z8rCzEycN
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

On Wed, Apr 15, 2020 at 10:18 AM, Laszlo Ersek wrote:<br />
<blockquote>ArmVirtPkg/ArmVirtPkg.ci.yaml<br />ArmVirtPkg/PlatformCI/Ubunt=
u-GCC5.yml<br />ArmVirtPkg/PlatformCI/PlatformBuild.py<br />ArmVirtPkg/Plat=
formCI/README-pytools.md<br />ArmVirtPkg/PlatformCI/iasl_ext_dep.yaml</bloc=
kquote>
<br />I am ok with the above except one thought on the readme.&nbsp; One n=
ice thing about the markdown readme files are the badge shows up in github =
when you view the package.&nbsp; This is a quick and easy way to see the cu=
rrent status.&nbsp;&nbsp;<br />
<ul>
<li>Ovmf has a pretty stale readme and does not take advantage of markdown=
.&nbsp; &nbsp; We could convert it to MD, clean up, and then merge in the c=
ontent from the pytools.md.&nbsp; I would need help or a package maintainer=
 to do the cleanup of the readme to make sure it contained the content you =
desired.&nbsp;&nbsp;</li>
<li>ArmVirtPkg doesn't have a readme and this is definitely a barrier to e=
ntry for the package.&nbsp; I would suggest creating one and then merging i=
n the content from the pytools.md.</li>
<li>EmulatorPkg has one.&nbsp; I would just suggest a merge but i am yet t=
o get any feedback from those maintainers.&nbsp;&nbsp;</li>
</ul>
If that isn't desirable i would at least suggest we change the title to ju=
st ReadMe.md so that GitHub shows it by default when the PaltformCI folder =
is viewed form the web or in editor like vscode.&nbsp;&nbsp;<br /><br />Tha=
nks<br />Sean<br />

--q1kxoIWIM48Z8rCzEycN--