Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 985 Bytes

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 985 Bytes

Contributing to Naavik

We welcome contributions :)

Installing & Running Cartographger

Opening issues

If you find a bug, please feel free to open an issue

Submitting a PR

Fixing bugs

We love pull requests. Here’s a quick guide:

  1. Fork this reposiroty and then clone it locally:
git clone https://github.com/istio-ecosystem/naavik
  1. Create a branch for your changes:
git checkout -b branch-name
  1. Do the change/fix & commit a change:
git add <files changed>
git commit -m "Summary of the change in one liner"
  1. Run the tests:
make test
make lint
  1. If everything looks good, push to your fork:
git push origin branch-name
  1. Create a Pull Request here

  2. Post review the Pull Request can be submitted