NativeScript / NativeScript/runtimes
Provide contributing instructions in README
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 25
- Forks
- 4
- Avg merge
- 5d 19h
- Merged PRs (30d)
- 3
Description
The README on this project seems way out of date. It does not describe the purpose and operation of any of the shell scripts or npm scripts, nor how to set up the repo.
See the README on https://github.com/NativeScript/runtime-node-api for the kind of instructions I'm looking for.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository README and inventory the shell scripts and npm scripts mentioned in the issue, then compare the requested coverage with the referenced runtime-node-api README. Done means the README explains the project's purpose, repository setup, and the purpose and operation of those scripts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100