Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.24 KB

contributing.md

File metadata and controls

58 lines (38 loc) · 1.24 KB
Raw

Contributing

Thank you for considering contributing. You'll find below useful information about how to contribute to the project.

Contributing code

Install from sources

  1. Install and run the latest version of Docker
  2. Verify your Go version (>= 1.11)
  3. Fork this repository
  4. Clone it outside of your GOPATH (we're using Go modules)

Working with git

1 Create your feature branch:

git clone # or git fetch 
git checkout -b my-new-feature origin/master

2 Commit your changes (we're using Conventional Commits):

git commit -am "type: description"

3 Push to the branch:

git push origin my-new-feature

4 See Your recently pushed branches on page Pull requests.

Testing

Run all tests:

make codequality
# or
make run-in-docker cmd="make codequality"

Reporting bugs and feature request

Your issue or feature request may already be reported! Please search on the issue tracker before creating one.

If you do not find any relevant issue or feature request, feel free to add a new one!

Additional resources