Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.42 KB
Raw

Contributing

We seek any feedback and are open to contribution.

Feel free to:

It would be very helpful if you:

  • tell us what is missing in the documentation and examples,
  • share your experience report,
  • propose features that you find critical or extremely useful,
  • share goyek with others by writing a blog post, giving a speech at a meetup or conference, or even telling your colleagues that you work with.

Make sure to be familiar with our Code of Conduct.

Developing

Run ./goyek.sh (Bash) or .\goyek.ps1 (PowerShell) to execute the build pipeline.

The repository contains basic confiugration for Visual Studio Code.

Releasing

Pre-release

  1. Update instrumentationVersion value in otelgoyek/otelgoyek.go.

  2. Update CHANGELOG.md with the new release.

  3. Push the changes and create a Pull Request on GitHub named Release <version>.

Release

  1. Add and push a signed tag:

    TAG='v<version>'
COMMIT='<commit-sha>'
git tag -s -m $TAG $TAG $COMMIT
git push upstream $TAG

  2. Create a GitHib Release named <version> with v<version> tag.

    The release description should include all the release notes from the CHANGELOG.md for this release.