kubernetes-sigs / release-team-shadow-stats

Kubernetes release team shadow program application analysis
Apache License 2.0
14 stars 6 forks source link

Update the README.md to highlight the purpose of this repo #2

Closed leonardpahlke closed 2 years ago

leonardpahlke commented 2 years ago

Currently, the README is still a bit cryptic about the purpose of this project. It should be clear why this project exists and what it is trying to solve and how.

At a glance, the project takes care of two things:

  1. reporting to the community on the release team's shadow program to increase transparency and use that as a basis for improvement.
  2. filtering and converting the data into a readable format (markdown) that can be easily read in a selection process (not walking the excel sheet anymore).

This should be included and expanded in the README.

cc @justaugustus @jeremyrickard

/assign @leonardpahlke

liquidsaul commented 2 years ago

/assign @liquidsaul

leonardpahlke commented 2 years ago

ref tracking issue https://github.com/kubernetes-sigs/release-team-shadow-stats/issues/4

leonardpahlke commented 2 years ago

in progress...

first iteration...

see fork https://github.com/leonardpahlke/release-team-shadow-stats/tree/update-readme