Missing instructions on running project inside README.md

Open
#79 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
go, sqlite
Domain
documentation

Research direction

README.md is the only file named; start by inspecting the repository's existing test and database setup and the command used to run the project. Update README.md with instructions for creating the test database, running tests, and running the project, then verify each documented procedure.

Written by the indexing model from the issue text.

Description

README is missing some instructions

  • How to create the DB for tests
  • How to run the tests
  • How to run the project
Dominant language
Go
Stars
13
Forks
11
No merged PRs in 30d

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 tursodatabase/libsql-shell-go

All issues in tursodatabase/libsql-shell-go

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.