Skip to content

Commit 551cb58

Browse files
committed
Docs updates
1 parent 2cc2779 commit 551cb58

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Contributing
22

3-
We encourage pull requests from everyone.
3+
We encourage pull requests (PRs) from everyone.
44

5-
Fork the project into your own repo, create a topic branch there and then make one or more pull requests back to the main repository. Your pull requests can then be reviewed and discussed.
5+
Fork the project into your own repo, create a topic branch there and then make one or more pull requests back to the main repository. Your PR can then be reviewed and discussed.
6+
7+
Helpful: Run `make` in the project root directory and ensure tests pass. If tests are not passing and you need help resolving, please mention this in your PR.
68

79

810
## Adding new feature layers
@@ -14,3 +16,5 @@ Checklist for adding new feature layers:
1416
* Update `flex-config/run-no-tags.lua`
1517
* Update `flex-config/run-no-tags.sql`
1618
* Update `db/qc/features_not_in_run_all.sql`
19+
* Add relevent `tests/sql/<feature_queries>.sql`
20+
* Add relevent `tests/expected/<feature_queries>.out`

docs/DOCKER-BUILD.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ docker build -t rustprooflabs/pgosm-flex .
1818
Tag with version.
1919

2020
```bash
21-
docker build -t rustprooflabs/pgosm-flex:0.1.2 .
21+
docker build -t rustprooflabs/pgosm-flex:0.3.4 .
2222
```
2323

2424
Push to Docker Hub.
2525

2626
```bash
27-
docker push rustprooflabs/pgosm-flex:0.1.2
27+
docker push rustprooflabs/pgosm-flex:0.3.4
2828
docker push rustprooflabs/pgosm-flex:latest
2929
```

0 commit comments

Comments
 (0)