Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
dam5s committed Aug 13, 2023
1 parent a9d5c70 commit 7029485
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,18 @@ make format
If your prefer a different line length, feel free to update the `Makefile` to your team's liking
and have developers configure their IDE as well.

## Checking for cyclic dependencies

Make sure your imports are relative only for files in the same folder, otherwise use `package:` imports.
Run the make task for checking cycles:

```
make check-cycles
```

## Check before push

To check formatting and run tests before pushing your code
To check formatting, cyclic dependencies and run tests before pushing your code

```
make check
Expand Down

0 comments on commit 7029485

Please sign in to comment.