modelcontextprotocol/go-sdk
Watch
1
0
Fork
You've already forked go-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

feat(ci): Ensure that the README.md is in sync with internal/readme (#53)

Browse source
This commit is contained in:
Robert Jackson 2025-06-26 11:45:44 -05:00 • committed by GitHub
commit 9f6dd5c32e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 51 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md
View file

@ -105,6 +105,19 @@ copyright header following the format below:
// license that can be found in the LICENSE file.
```
### Updating the README
The top-level `README.md` file is generated from `internal/readme/README.src.md`
and should not be edited directly. To update the README:
1. Make your changes to `internal/readme/README.src.md`
2. Run `make` in the `internal/readme/` directory to regenerate `README.md`
3. Commit both files together
The CI system will automatically check that the README is up-to-date by running
`make` and verifying no changes result. If you see a CI failure about the
README being out of sync, follow the steps above to regenerate it.
## Code of conduct
This project follows the [Go Community Code of Conduct](https://go.dev/conduct).