Skip to content

Commit ff43702

Browse files
authored
Copy follow-up instructions to README (frequenz-floss#67)
For reference after the configuration script was run.
2 parents ba64220 + 47d7872 commit ff43702

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,16 @@ cookiecutter gh:frequenz-floss/frequenz-repo-config-python --directory=cookiecut
4242

4343
This will prompt for the project type, name and other configuration and
4444
generate the whole project for you.
45+
46+
After completing it and fixing the TODOs
47+
you can amend the previous commit using `git commit --amend`
48+
or create a new commit for the changes using `git commit`.
49+
You can make sure linting and tests pass by creating a virtual
50+
environment, installing the development dependencies and running `nox`:
51+
```sh
52+
# requires at least python version 3.11
53+
python3 -m venv .venv
54+
. .venv/bin/activate
55+
pip install .[dev-noxfile]
56+
nox
57+
```

0 commit comments

Comments
 (0)