Add READMEs to every package

[dmathieu]

Replacement for #5102.

[dmathieu]

All link issues are 429s from pkg.go.dev. I'll rerun this in a bit.

[pellared]

I like this 👍

[MrAlias]

Are we moving away from package being is go files? I thought the group decided to not straddle having it there and in a README.md?

[pellared]

Are we moving away from package being is go files? I thought the group decided to not straddle having it there and in a README.md?

The proposal is to have readme files that would just refer to pkg.go.dev.
See:

• Add a readme file to opencensus #5102 (comment)
• Add a readme file to opencensus #5102 (comment)

[MrAlias]

Are we moving away from package being is go files? I thought the group decided to not straddle having it there and in a README.md?

The proposal is to have readme files that would just refer to pkg.go.dev. See:

• Add a readme file to opencensus #5102 (comment)
• Add a readme file to opencensus #5102 (comment)

Can we clarify in our contributing guidelines that we do not add documentation to the readme and Go docs?

[dmathieu]

Can we clarify in our contributing guidelines that we do not add documentation to the readme and Go docs?

Sure. How about the current wording?

[dashpole]

I like this a lot

[dmathieu]

I have moved the check to a script executable from the Makefile, and added it to make precommit.
The script will also now run through each package, output for any that fails, and exit with an error if any failed.

open-telemetry/opentelemetry-go›  git:(readme-for-all-packages) 3D2M 1A make verify-readmes
./verify_readmes.sh
couldn't find README.md for ./bridge/opencensus
couldn't find README.md for ./bridge/opentracing
Error: some READMEs couldn't be found.
make: *** [verify-readmes] Error 1

[pellared]

🏅