Skip to content

Commit

Permalink
Fix md
Browse files Browse the repository at this point in the history
  • Loading branch information
svdimchenko committed Oct 4, 2023
1 parent bf3a1e4 commit 2120c97
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
23 changes: 14 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
# Contributing

## Requirements

* Python from 3.7 to 3.11
* Virtual Environment or any other Python environment manager


## Getting started

* Clone of fork the repo
* Run `make setup`, it will:
1. Install all dependencies
2. Install pre-commit hooks
3. Generate your `.env` file
1. Install all dependencies
2. Install pre-commit hooks
3. Generate your `.env` file

* Adjust `.env` file by configuring the environment variables to match your Athena development environment.

## Running tests

We have 2 different types of testing:

* **unit testing**: you can run this type of tests running `make unit_test`
* **functional testing**: you must have an AWS account with Athena setup in order to launch this type of tests and have a `.env` file in place with the right values.
* **functional testing**: you must have an AWS account with Athena setup in order to launch this type of tests and have
a `.env` file in place with the right values.
You can run this type of tests running `make functional_test`

All type of tests can be run using `make`:

```bash
make test
```
Expand All @@ -31,17 +34,19 @@ make test

* Create a commit with your changes and push them to a
[fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
* Create a [pull request on
Github](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
<!-- markdownlint-disable-next-line MD013 -->
* Create a [pull request on Github](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
* Pull request title and message (and PR title and description) must adhere to
[conventionalcommits](https://www.conventionalcommits.org).
[conventional commits](https://www.conventionalcommits.org).
* Pull request body should describe _motivation_.
<!-- markdownlint-restore -->

### General Guidelines

* Keep your Pull Request small and focused on a single feature or bug fix.
* Make sure your code is well tested.
* Make sure your code is well documented.
* Provide a clear description of your Pull Request to allow the reviewer to understand the context of your changes.
* Consider the usage of draft Pull Request and switch to ready for review only when the CI pass or is ready for feedback.
* Consider the usage of draft Pull Request and switch to ready for review only when the CI pass or is ready for
feedback.
* Be sure to have pre-commit installed or run `make pre-commit` before pushing your changes.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,7 @@
To start, you will need an S3 bucket, for instance `my-bucket` and an Athena database:

```sql
CREATE
DATABASE IF NOT EXISTS analytics_dev
CREATE DATABASE IF NOT EXISTS analytics_dev
COMMENT 'Analytics models generated by dbt (development)'
LOCATION 's3://my-bucket/'
WITH DBPROPERTIES ('creator'='Foo Bar', 'email'='[email protected]');
Expand Down

0 comments on commit 2120c97

Please sign in to comment.