-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: proper go contributing docs instead of js (#12)
- Loading branch information
1 parent
5749e84
commit 52c77b3
Showing
1 changed file
with
21 additions
and
5 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <module>/v<sem version> -m "release: <module>@v<sem version>" | ||
``` | ||
|
||
For example: | ||
|
||
```bash | ||
nx run-many --targets=build | ||
npx lerna publish --no-private | ||
git tag -a traceloop-sdk/v0.0.4 -m "release: [email protected]" | ||
``` |