diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..809e04c --- /dev/null +++ b/CONTRIBUTING.md @@ -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 ...) +``` diff --git a/Cargo.toml b/Cargo.toml index 2215129..b9338b1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,9 +9,9 @@ members = [ version = "0.1.4" license = "Apache-2.0" edition = "2021" -authors = ["Mara Schulke "] +authors = ["Mara Schulke "] 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] diff --git a/README.md b/README.md index ae34c69..eeccbc9 100644 --- a/README.md +++ b/README.md @@ -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