Skip to content

docs: Clarify Compatibility Guarantees in contrib's README #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Jun 10, 2025
Merged

docs: Clarify Compatibility Guarantees in contrib's README #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions contrib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ fixes.
* **Error Handling:** Handle errors gracefully with informative messages.
* **Documentation:** Document your code and its usage.

**Compatibility Guarantees:**

* All code in `contrib/` is explictly not covered by any sort of backwards API Compatibility Guarantees, even across minor (patch) releases.
* The maintainers (committers) of this project are going to merge any changes in both implementations and interfaces without API stability concerns.
* Contributors are welcome to raise their PRs based on this policy, and incrementally improve code without worrying about API breakage.
Comment on lines +23 to +24
Copy link
Contributor

@shukladivyansh shukladivyansh Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Point 2 and 3 feel redundant with the first one.


**Contrib Graduation:**

We'll consider graduating community contributions into officially maintained
Expand Down