From 52c77b32fc2d0ab8a36c1a26cdb76a426471d959 Mon Sep 17 00:00:00 2001 From: Neko Date: Fri, 27 Dec 2024 05:55:55 +0800 Subject: [PATCH] docs: proper go contributing docs instead of js (#12) --- CONTRIBUTING.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f43dca..9886f26 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,30 @@ -# Contributing to OpenLLMetry-JS +# Contributing to `go-openllmetry` Thanks for taking the time to contribute! 😃 🚀 Please refer to our [Contributing Guide](https://traceloop.com/docs/openllmetry/contributing/overview) for instructions on how to contribute. -## Releasing +### Prerequisites -To release a new version of the package, run (make sure you have access to the `@traceloop` npm organization): +- `go` version `v1.21.0+` + +## Development + +Clone the repository: + +```bash +git clone https://github.com/traceloop/go-openllmetry +cd go-openllmetry +``` + +## Release + +```bash +git tag -a /v -m "release: @v" +``` + +For example: ```bash -nx run-many --targets=build -npx lerna publish --no-private +git tag -a traceloop-sdk/v0.0.4 -m "release: traceloop-sdk@v0.0.4" ```