No documentation for dealing with unusual Github release tags

Open Beginner friendly
#501 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
github
Domain
documentation

Research direction

Start with the documentation covering gh() and the existing guidance provided by Owen-sz. Document how to handle release tags that are not purely semver, including the string-manipulation workaround, so someone new to rhai can find and follow it.

Written by the indexing model from the issue text.

Description

Some projects (i.e, vectorscan, suricata) use release tagging that isn't purely semver tagging. This causes gh() to break. Documentation was provided by @Owen-sz for how to work around this using string manipulation but this isn't made clear for people working with rhai for the first time.

Dominant language
MDX
Stars
14
Forks
19
Avg merge
7d 12h
Merged PRs (30d)
9

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from FyraLabs/devdocs

All issues in FyraLabs/devdocs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.