margelo / margelo/nitro

Documentation Request: Testing Example

Open
#629 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
C++
Stars
1.9k
Forks
117
Avg merge
1d 8h
Merged PRs (30d)
44

Description

Hey There!

Love working with this library, and the documentation is super comprehensive, appreciate it!

I wonder if you'd be able to provide documentation that includes examples on how to test both the TS and native side of nitro-modules. As far as I've seen this is the only piece thats missing, and it would be great to have this story covered.

Thanks in advance!

Contributor guide

Open the contributing guide

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.

Research direction

No files, tests, or entry points are named. Start by reviewing the existing documentation and testing setup for TypeScript and native Nitro modules; the work is done when both sides have clear testing examples documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, kotlin, swift, typescript
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.