square / square/luks2crypt

Document luksversion flag

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

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Go
Stars
50
Forks
13
Avg merge
27m
Merged PRs (30d)
7

Description

Document --luksversion usage in README.md. Also, provide some background on what version to use in relation to Ubuntu version.

https://github.com/square/luks2crypt/issues/66#issuecomment-844789565

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 with README.md and the linked issue comment for the existing context around --luksversion. Document the flag's usage and explain which version to use with each Ubuntu version; the README should answer both questions without requiring further investigation.

Written by the indexing model from the issue text.

Assessment

Tech stack
linux, ubuntu
Domain
cli, documentation, operating-systems
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.