-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add contribution guidelines and fix invalid repo URL in Cargo.t…
…oml (#20) * fix: correct repo location and mail * doc: add contribution guidelines
- Loading branch information
1 parent
3ae767b
commit 71fe584
Showing
3 changed files
with
26 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contributing to `atmosphere` | ||
|
||
We welcome contributions, big and small! | ||
|
||
## Testing | ||
|
||
Tests in `atmosphere` need a database to work with. | ||
We provide a `docker-compose` service for this, you can use it in the following way: | ||
|
||
```bash | ||
$ docker-compose -f ./tests/postgres.yml up -d | ||
$ export DATABASE_URL="postgres://atmosphere:atmosphere@localhost" | ||
$ cargo test -F postgres | ||
(... snip ...) | ||
running 4 tests | ||
test db::crud::read ... ok | ||
test db::crud::create ... ok | ||
test db::crud::delete ... ok | ||
test db::crud::update ... ok | ||
|
||
test result: ok. 4 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.27s | ||
(... snip ...) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters