queryverse / queryverse/QuerySQLite.jl

Improve documentation

Open
#15 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
4
Forks
2
Avg merge
2d 3h
Merged PRs (30d)
1

Description

@davidanthoff I think it probably makes more sense to spend time improving the documentation rather than writing a blog post. One thing I know about myself is that I'm a terrible communicator, so let me know what you think of the documentation as it is and what I should add. Barring that, I'd say this package is ready to announce to the public.

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.

Research direction

Start by reviewing the package's current documentation and compare it with what a public announcement would require. The issue does not name documentation files, tests, or specific missing content, so clarify the additions with the maintainers before starting; done means the agreed documentation improvements are complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.