Skip to content

Commit

Permalink
docs: Add contribution guidelines and fix invalid repo URL in Cargo.t…
Browse files Browse the repository at this point in the history
…oml (#20)

* fix: correct repo location and mail

* doc: add contribution guidelines
  • Loading branch information
poliorcetics authored Apr 23, 2024
1 parent 3ae767b commit 71fe584
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
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 ...)
```
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ members = [
version = "0.1.4"
license = "Apache-2.0"
edition = "2021"
authors = ["Mara Schulke <mara.schulke@bmc-labs.com>"]
authors = ["Mara Schulke <mara.schulke@helsing.ai>"]
description = "A lightweight sql framework for sustainable database reliant systems"
repository = "https://github.com/bmc-labs/atmosphere"
repository = "https://github.com/helsing-ai/atmosphere"
keywords = ["sqlx", "postgres", "database", "orm", "backend"]

[workspace.dependencies]
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ Atmosphere is able to generate utility queries to move across `Table` boundaries
## Contribution

We welcome contributions! Please see our contribution guidelines for more details.
We welcome contributions! Please see [our contribution guidelines](CONTRIBUTING.md) for more details.

## License

Expand Down

0 comments on commit 71fe584

Please sign in to comment.