chore: improved readme

[ascandone]

• Moved "develop locally" section to the CONTRIBUTING.md file (will improve it later on)
• added a github relase and golang package badge
• added playground link

[coderabbitai]

Walkthrough

The changes update two documentation files. In CONTRIBUTING.md, new sections have been added that provide instructions for local development, including guidance for updating test snapshots with UPDATE_SNAPS=true and updating the parser via the generate-parser.sh script (which requires the antlr4 command). Meanwhile, README.md has been revised to replace an old badge with a new "GitHub Release" badge, add a "Go Reference" badge, adjust badge order, improve the Numscript description by adding a period, and introduce a sentence pointing users to an online playground. The local development section has been completely removed from README.md.

Changes

File	Change Summary
CONTRIBUTING.md	Added new local development instructions, including updating snapshots using UPDATE_SNAPS=true and generating the parser via generate-parser.sh (requires antlr4).
README.md	Reordered badges by adding a "GitHub Release" badge and a "Go Reference" badge, modified the Numscript description with a period and online playground notice, and removed the local development section.

Poem

I'm a rabbit with a happy beat,
Hopping through docs with nimble feet,
New instructions bloom like fresh spring air,
Badges gleam with a radiant flair,
I nibble code and dance with delight,
Celebrating these changes from morning to night!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b1cf56 and b8eb61c.

📒 Files selected for processing (1)

• README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.08%. Comparing base (383681a) to head (b8eb61c).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #42   +/-   ##
=======================================
  Coverage   63.08%   63.08%           
=======================================
  Files          31       31           
  Lines        6889     6889           
=======================================
  Hits         4346     4346           
  Misses       2342     2342           
  Partials      201      201           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

8-9: Improved Description with Online Playground Link

The updated description now ends with a period, which enhances readability, and the addition of the online playground link is a useful call-to-action for users.

• Minor nitpick: Consider revising “financial transaction” to “financial transactions” for grammatical consistency.
• Suggestion: Optionally, you might add a trailing period at the end of the online playground sentence for consistency with the rest of the text.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 383681a and 2b1cf56.

📒 Files selected for processing (2)

• CONTRIBUTING.md (1 hunks)
• README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• CONTRIBUTING.md

🔇 Additional comments (1)

README.md (1)

3-6: Enhanced Badge Section!

The new “GitHub Release” and “Go Reference” badges have been correctly added and are now placed ahead of the other badges. This improves the visibility of the release status and related documentation.