unitycatalog / unitycatalog/unitycatalog
[DOC] Quickstart guide should indicate to build the package before launching the server and issuing any uc cli commands
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 3.5k
- Forks
- 672
- Avg merge
- 6d 16h
- Merged PRs (30d)
- 30
Description
Impatient developers don't sift through README; they jump to quickstart and get on with it. And rightly so. So to make their first impressions positive, steps in the quickstart guide should just work!
One thing lacking in the quickstart guide is to ensure that after cloning the repo, they ought to build the package
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 by opening the quickstart guide and tracing the steps after cloning the repository. Update the instructions so the package is built before launching the server or issuing any uc CLI commands; the quickstart should work in that order for a fresh checkout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100