Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.01 KB

contributing.md

File metadata and controls

31 lines (22 loc) · 1.01 KB

Intro

  • Hello, thank you for considering contributing to shorte.live.

Note

  • You can reach out to me for discussion or help. (Please keep things professional and straight, don't waste my time)
  • Discord : ivinayakg
  • Email : [email protected]

Getting Started

  • First fork this project.
  • Follow the setup from the README file to set it up locally.
  • and done.

Rules

  • Keep things neat and clean.
  • Have proper issue ticket or any public document, which explains your work thoroughly.
  • Before raising your PR run your tests on your local system. Only after there are no errors on your local, please push your code.
  • Every PR must have tests for the code written. (for now backend only, as I'm currently setting up the frontend testing architecture)

Running tests on local

  • Simply open your terminal, change to api directory with cd api.
  • Run
    go test ./tests/integration
    go test ./tests/unit