Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add contribution guidelines and fix invalid repo URL in Cargo.toml #20

Merged
merged 2 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading