CSCfi / CSCfi/sd-lock-util

Fix getting started

Open
#2 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Hi,

Getting started instructions don't work due to typos:

```
git clone git@github.com/CSCfi/sd-lock-util.git
cd sd-lock-util
pip install -r requirements.txt
pip install .[]
```

First line throws `fatal: repository 'git@github.com/CSCfi/sd-lock-util.git' does not exist`
Last command doesn't work

Change to these:

```
git clone https://github.com/CSCfi/sd-lock-util.git
cd sd-lock-util
pip install -r requirements.txt
pip install .
```

Contributor guide

Open the contributing guide

Research direction

Start by locating the getting-started instructions containing requirements.txt and the shown setup commands. Compare them with the commands in the issue and verify that the documented clone and installation steps work from a clean checkout.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.