lenra-io / lenra-io/template-python

[Task] Make command copyable in README

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

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

What should be done

Make readme proper
To make it from this

cargo install lenra_cli --version=1.0.0-beta.5
# or `cargo install lenra_cli@1.0.0-beta.5`

to this

cargo install lenra_cli --version=1.0.0-beta.5

or

cargo install lenra_cli@1.0.0-beta.5`

As it makes it time consuming.
Also a hacktoberfest label would be of help.

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

Open the README and find the installation example containing the lenra_cli cargo commands. Update the examples so each command can be copied directly, preserving the requested version, then check the rendered README for balanced code formatting.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.