Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

93 lines (67 loc) · 3.2 KB
Raw

How to contribute to dblab

Thank you for considering contributing to dblab!

First time setup

  • Fork dblab to your GitHub account by clicking the Fork button.
  • Clone the main repository locally.
git clone https://github.com/danvergara/dblab.git
cd dblab
  • Add your fork as a remote to push your work to. Replace {username} with your username. This names the remote "fork", the default dblab remote is "origin".
git remote add fork https://github.com/{username}/dblab

Start coding

  • Create a branch to identify the issue, feature addition or change you would like to work on.
git fetch origin
git checkout -b your-branch-name origin/main
  • Using your favorite editor, make your changes.
  • Include tests that cover any code changes you make. Make sure the test fails without your patch. Run the tests as described below.
  • Commit your changes following the conventional commit (commitizen is a great tool for this purpose). The reasoning behind it is that it is easier to read, and enforces writing descriptive commits.
  • Push your commits to your fork on GitHub and create a pull request. Link to the issue being addressed with fixes #123 in the pull request in the case that you are working on an issue.
git push --set-upstream fork your-branch-name

Running the tests

Setting up the environment

First of all, the repository includes a docker-compose file and a makefile. The docker file declares 4 services: a postgres container, a mysql one, a dblab container that runs migrations and seeds on the postgres container and other one that does the same for the mysql container. The makefile is used to automate some task. To spin up all the containers type:

make up

Then, you'll have 2 containers up and running in your system for every kind of database supported by dblab.

Run dblab opening a connection with the postgres container.

make run

You can do the same with the mysql container by running:

make run-mysql

Run the unit test suite with make.

make unit-test

Run the integration test with make too, but make sure the database containers are up and running.

make int-test

This runs the tests. You can check all the options with help command.

Usage:
test           Runs the tests
unit-test      Runs the tests with the short flag
int-test       Runs the integration tests
linter         Runs the colangci-lint command
test-all       Runs the integration testing bash script with different database docker image versions
docker-build   Builds de Docker image
build          Builds the Go program
run            Runs the application
up             Runs all the containers listed in the docker-compose.yml file
down           Shut down all the containers listed in the docker-compose.yml file
help           Prints this help message