clarify

Author: aaxelb

CONTRIBUTING.md

@@ -1,16 +1,18 @@
 # CONTRIBUTING
 
-> note: this codebase is currently (and historically) rather entangled with [osf.io](https://osf.io), which has its shtrove at https://share.osf.io/trove -- stay tuned for more-reusable open-source libraries and tools that should be more accessible to community contribution
+> note: this codebase is currently (and historically) rather entangled with [osf.io](https://osf.io), which has its shtrove at https://share.osf.io -- stay tuned for more-reusable open-source libraries and tools that should be more accessible to community contribution
 
 For now, if you're interested in contributing to SHARE/trove, feel free to
 [open an issue on github](https://github.com/CenterForOpenScience/SHARE/issues)
 and start a conversation.
 
-## Requirements
+## Required checks
 
-All new changes must pass the following checks with no errors:
-- unit tests: `python -m pytest -x tests/`
+All changes must pass the following checks with no errors:
 - linting: `python -m flake8`
 - static type-checking (on `trove/` code only, for now): `python -m mypy trove`
+- tests: `python -m pytest -x tests/`
+    - note: some tests require other services running -- if [using the provided docker-compose.yml](./how-to/run-locally.md), recommend running in the background (upping worker ups all: `docker compose up -d worker`) and executing tests from within one of the python containers (`indexer`, `worker`, or `web`):
+        `docker compose exec indexer python -m pytest -x tests/`
 
-All new changes should also avoid decreasing test coverage, when reasonably possible.
+All new changes should also avoid decreasing test coverage, when reasonably possible (currently checked on github pull requests).

README.md

@@ -6,7 +6,7 @@
 
 SHARE/trove (aka SHARtrove, shtrove) is is a service meant to store (meta)data you wish to keep and offer openly.
 
-note: this codebase is currently rather entangled with [osf.io](https://osf.io), which has its shtrove at https://share.osf.io/trove -- stay tuned for more-reusable open-source libraries and tools for working with (meta)data
+note: this codebase is currently (and historically) rather entangled with [osf.io](https://osf.io), which has its shtrove at https://share.osf.io -- stay tuned for more-reusable open-source libraries and tools for working with (meta)data
 
 see [ARCHITECTURE.md](./ARCHITECTURE.md) for help navigating this codebase