Skip to content

Commit 4cf96ab

Browse files
williammartinSamMorrowDrums
authored andcommitted
Indicate Go API stability in README
1 parent 923e1b0 commit 4cf96ab

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,10 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
435435
- `prNumber`: Pull request number (string, required)
436436
- `path`: File or directory path (string, optional)
437437

438+
## Library Usage
439+
440+
The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.
441+
438442
## License
439443

440444
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.

0 commit comments

Comments
 (0)