github.com/eatigo/migrate@v3.0.2-0.20210729130915-7610befb1b6b+incompatible/CONTRIBUTING.md (about)

     1  # Development, Testing and Contributing
     2  
     3    1. Make sure you have a running Docker daemon
     4       (Install for [MacOS](https://docs.docker.com/docker-for-mac/))
     5    2. Fork this repo and `git clone` somewhere to `$GOPATH/src/github.com/%you%/migrate`
     6    3. `make rewrite-import-paths` to update imports to your local fork
     7    4. Confirm tests are working: `make test-short`
     8    5. Write awesome code ...
     9    6. `make test` to run all tests against all database versions
    10    7. `make restore-import-paths` to restore import paths
    11    8. Push code and open Pull Request
    12   
    13  Some more helpful commands:
    14  
    15    * You can specify which database/ source tests to run:  
    16      `make test-short SOURCE='file go-bindata' DATABASE='postgres cassandra'`
    17    * After `make test`, run `make html-coverage` which opens a shiny test coverage overview.  
    18    * Missing imports? `make deps`
    19    * `make build-cli` builds the CLI in directory `cli/build/`.
    20    * `make list-external-deps` lists all external dependencies for each package
    21    * `make docs && make open-docs` opens godoc in your browser, `make kill-docs` kills the godoc server.  
    22      Repeatedly call `make docs` to refresh the server.