Skip to content

Commit 42bfaef

Browse files
karyonniklasmohrin
andauthored
Fix readme papercuts, add process-compose.socket to .gitignore (#2590)
Small things I stumbled over while setting this up. --------- Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
1 parent f591d46 commit 42bfaef

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ docs/_build
3333
coverage.xml
3434
htmlcov
3535

36+
# Ignored by default, but seen as untracked in WSL once
37+
process-compose.socket
38+
3639
# pip puts editable packages here
3740
src
3841
!evap/static/ts/.prettierrc.json

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,13 @@ Afterwards, `nix run .#services-full` will recreate a default development enviro
4545

4646
We'd love to see contributions! PRs solving existing issues are most helpful to us. It's best if you ask to be assigned for the issue so we won't have multiple people working on the same issue. Feel free to open issues for bugs, setup problems, or feature requests. If you have other questions, feel free to contact the [organization members](https://github.com/orgs/e-valuation/people). You should probably branch off `main`, the branch `release` is used for stable revisions.
4747

48-
Before committing, run the following commands:
49-
- `./manage.py test` (runs the test suite)
50-
- `./manage.py lint` (runs linting)
48+
Before committing, run `./manage.py precommit` or alternatively, the individual commands:
49+
- `./manage.py typecheck`
50+
- `./manage.py test`
51+
- `./manage.py lint`
5152
- `./manage.py format` (applies automatic code formatting)
5253

53-
or, to combine all three, simply run `./manage.py precommit`.
54-
55-
You can also set up `pylint`, `isort`, `black` and `prettier` in your IDE to avoid doing this manually all the time.
54+
You can also set up `ruff`, `pylint`, and `prettier` in your IDE to avoid doing this manually all the time.
5655

5756
### Creating a Pull Request (Workflow Suggestion)
5857
1. (once) [Fork](https://github.com/e-valuation/EvaP/fork) the repository so you have a GitHub repo that you have write access to.

evap/evaluation/management/commands/precommit.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ def handle(self, *args, **options):
1818
sys.exit(1)
1919

2020
call_command("typecheck")
21+
call_command("format")
22+
call_command("lint")
2123

2224
# subprocess call so our sys.argv check in settings.py works
2325
subprocess_run_or_exit(["./manage.py", "test"], self.stdout)
24-
25-
call_command("format")
26-
call_command("lint")

0 commit comments

Comments
 (0)