safedep/vet
1
0
Fork 0
mirror of https://github.com/safedep/vet.git synced 2025-12-10 00:22:08 -06:00
Code Issues Packages Projects Releases 68 Wiki Activity
vet/CONTRIBUTING.md
Omkar Phansopkar 932269d6bb
Updated contributing.md 
Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com>
2025-06-19 20:22:04 +05:30

1.3 KiB
Raw Blame History

Contributing Guide

You can contribute to vet and help make it better. Apart from bug fixes, features, we particularly value contributions in the form of:

  • Documentation improvements
  • Bug reports
  • Using vet in your projects and providing feedback

How to contribute

  1. Fork the repository
  2. Add your changes
  3. Submit a pull request

How to report a bug

Create a new issue and add the label "bug".

How to suggest a new feature

Create a new issue and add the label "enhancement".

Development workflow

When contributing changes to repository, follow these steps:

  1. Ensure tests are passing
  2. Ensure you write test cases for new code
  3. Signed-off-by line is required in commit message (use -s flag while committing)

Developer Setup

Requirements

  • Go 1.24.3+

Install Dependencies

  • Install ASDF
  • Install the development tools
asdf plugin add golang
asdf plugin add gitleaks
asdf install
  • Install lefthook
go install github.com/evilmartians/lefthook@latest
  • Install git hooks
$(go env GOPATH)/bin/lefthook install

Build

Install build tools

make dev-setup

Generate code from API specs and build vet

make

Quick build without regenerating code from API specs

make quick-vet

Run Tests

make test