Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.83 KB
Raw

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

  • 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. You can run this type of tests running make functional_test

All type of tests can be run using make:

make test

Pull Request

  • Create a commit with your changes and push them to a fork.
  • Create a pull request on Github.
  • Pull request title and message (and PR title and description) must adhere to conventionalcommits.
  • Pull request body should describe motivation.

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.
  • Be sure to have pre-commit installed or run make pre-commit before pushing your changes.