Introduce minimal PACKAGE.md files for each package#336
Merged
jskeet merged 1 commit intocloudevents:mainfrom Apr 6, 2026
Merged
Introduce minimal PACKAGE.md files for each package#336jskeet merged 1 commit intocloudevents:mainfrom
PACKAGE.md files for each package#336jskeet merged 1 commit intocloudevents:mainfrom
Conversation
…he guide Signed-off-by: Erwin <erwinkramer@hotmail.com>
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Each package now has a PACKAGE.md with a consistent style. I refrained from making it a 100% covered information text, so it doesn't specify all types or covers everything you can do with it, maybe the GitHub docs and samples folders are a better place for that, ideologically it should just make people understand how to get something basic started very quickly. I made sure to link to the docs and samples folder for now in every package.md (even if they currently don't cover everything for that particular binding or formatter).
The guide.md had some small issues and missing references as well, so that's included too.
Closes #290