Skip to content

Add contributing guide#689

Open
ricardbejarano wants to merge 3 commits intowagoodman:mainfrom
bejaratommy:add-contributing-guide
Open

Add contributing guide#689
ricardbejarano wants to merge 3 commits intowagoodman:mainfrom
bejaratommy:add-contributing-guide

Conversation

@ricardbejarano
Copy link
Copy Markdown

Closes #491

The project lacked any build or contribution documentation. The maintainer acknowledged this need and asked for CONTRIBUTING.md and/or DEVELOPING.md to be added (#491 (comment)).

This PR adds CONTRIBUTING.md covering:

  • Prerequisites
  • Bootstrapping the local toolchain via make tools
  • Building (goreleaser snapshot and plain go build)
  • Running tests (make unit, make cli)
  • Running static analysis (make lint, make static-analysis)
  • Project layout overview
  • How to submit a PR
  • Code style notes

Signed-off-by: bejaratommy <tommy@bejara.net>
Signed-off-by: bejaratommy <tommy@bejara.net>
Signed-off-by: bejaratommy <tommy@bejara.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generic build instructions

2 participants