Skip to content

Commit

Permalink
Feature/split linting and testing (#14)
Browse files Browse the repository at this point in the history
* README badges updated to show split of CI into testing & linting.
* `make lint` has a formatting check
  • Loading branch information
epwr authored Mar 1, 2024
1 parent 3891037 commit 1820ed0
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,4 @@ jobs:
run: make venv

- name: Run Static Analysis
run: make lint

- name: Run Formatting
run: black --check app tests
run: make lint
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ VENV := venv
APP_DIR := app

# default target, when make executed without arguments
all: lint test
all: lint test format

$(VENV)/bin/activate:
python3 -m venv $(VENV)
Expand All @@ -14,6 +14,7 @@ venv: $(VENV)/bin/activate
lint: venv
./$(VENV)/bin/mypy app --strict
./$(VENV)/bin/flake8 app tests
./$(VENV)/bin/black --check app tests

# Use `yq` to parse config/testing.toml and set the env variables. Then run tests & coverage.
test: venv
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# distributed-ethnography

[![Continuous Integration](https://github.com/epwr/distributed-ethnography/actions/workflows/Continuous%20Integration.yml/badge.svg)](https://github.com/epwr/distributed-ethnography/actions/workflows/Continuous%20Integration.yml)
[![Tests](https://github.com/epwr/distributed-ethnography/actions/workflows/testing.yml/badge.svg)](https://github.com/epwr/distributed-ethnography/actions/workflows/testing.yml)
[![Linting](https://github.com/epwr/distributed-ethnography/actions/workflows/linting.yml/badge.svg)](https://github.com/epwr/distributed-ethnography/actions/workflows/testinglintingh.yml)

Distributed ethnography is a method of understanding a "community’s belief systems through their own narratives" (K Mausch, 2018). It tackles the idea
that it's very difficult to use technology to understand what someone means by having the storyteller quickly explain the meaning of their story across
Expand Down

0 comments on commit 1820ed0

Please sign in to comment.