Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rustprooflabs committed Oct 3, 2021
1 parent 2cc2779 commit 551cb58
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Contributing

We encourage pull requests from everyone.
We encourage pull requests (PRs) from everyone.

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.
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.

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.


## Adding new feature layers
Expand All @@ -14,3 +16,5 @@ Checklist for adding new feature layers:
* Update `flex-config/run-no-tags.lua`
* Update `flex-config/run-no-tags.sql`
* Update `db/qc/features_not_in_run_all.sql`
* Add relevent `tests/sql/<feature_queries>.sql`
* Add relevent `tests/expected/<feature_queries>.out`
4 changes: 2 additions & 2 deletions docs/DOCKER-BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ docker build -t rustprooflabs/pgosm-flex .
Tag with version.

```bash
docker build -t rustprooflabs/pgosm-flex:0.1.2 .
docker build -t rustprooflabs/pgosm-flex:0.3.4 .
```

Push to Docker Hub.

```bash
docker push rustprooflabs/pgosm-flex:0.1.2
docker push rustprooflabs/pgosm-flex:0.3.4
docker push rustprooflabs/pgosm-flex:latest
```

0 comments on commit 551cb58

Please sign in to comment.