Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (43 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 1.2 KB
Raw

Setup your machine

go-web is written in Go.

Prerequisites:

  • make
  • Go 1.14+
  • Docker
  • gpg (probably already installed on your system)

Clone goweb anywhere:

$ git clone git@github.com:StarpTech/go-web.git

Install the build and lint dependencies:

$ make setup

A good way of making sure everything is all right is running the test suite:

$ make test

Test your change

You can create a branch for your changes and try to build from the source as you go:

$ make

When you are satisfied with the changes, we suggest you run:

$ make ci

Which runs all the linters and tests.

Create a commit

Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.

You can follow the documentation on their website.

Submit a pull request

Push your branch to your go-web fork and open a pull request against the master branch.

Deployment

Tag a new release and push it to origin. This will trigger the Github CI to deploy the commit.

git tag v1.0.0
git push origin v1.0.0