lightninglabs / lightninglabs/taproot-assets

feature: modernize readme

Open
#2,284 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

meta
Dominant language
Go
Stars
525
Forks
150
Avg merge
2d 15h
Merged PRs (30d)
31

Description

Our trusty old README is, IMO, showing its age. Let's modernize and beautify it prior to v0.9.

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 reading the repository's README and reviewing its current structure and presentation. The issue does not specify which sections or improvements are wanted, so clarify the expected modernization and definition of done before editing. Completion should be a refreshed README accepted for the v0.9 preparation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.