[openstack-dev] [all][tc] Exposing project team's metadata in README files

Dulko, Michal michal.dulko at intel.com
Fri Nov 25 12:33:29 UTC 2016

On Fri, 2016-11-25 at 12:38 +0100, Flavio Percoco wrote:
> Greetings,
> Just a heads up for everyone. The work on this front has moved
> forward and the
> badges are now being generated as part of the governance CI[0].
> You can find the list of badges here[1] and the pattern is quite
> obvious, the
> name of the image is based on the project repo name.
> I've edited the README files for all repositories listed in the
> projects.yaml
> file and I've started to submit these patches[2]. I'm not a fan of
> "viral
> changes" but I've done my best to explain what's changing, provide
> references
> and examples on the commit message. These changes are being submitted
> using the
> tag 'project-badges'[2].

Looks like Cinder patch is missing there?

> Note that these badges are *JUST* a graphical representation of
> what's in the
> governance repo. If you don't want to have them in the README file, I
> guess it's
> fine. I'd, however, encourage everyone to add them to provide
> consistency and a
> more immediate information of what the project is about, what some of
> the
> project capabilities are and what its status is.
> Ideally this should also be added in projects documentation as well
> but I'll
> leave that to every team to do.
> Happy to answer questions,
> Flavio
> P.S: The current layout is being improved[3], if you have better
> ideas please
> help out.
> [0] https://review.openstack.org/#/c/391588/
> [1] http://governance.openstack.org/badges/
> [2] https://review.openstack.org/#/q/topic:project-badges
> [3] https://review.openstack.org/#/c/399278/

More information about the OpenStack-dev mailing list