Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 999 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 999 Bytes
Raw

Steps for Contributing:

  1. Fork the repo master branch (or feature branch if adding to another feature).
  2. Add or modify unit tests to properly test your change. Make sure code coverage does not decrease.
  3. If your change effects the usage, update README to reflect the change.
  4. Make sure you have proper GoDoc documentation for all Public interfaces, structs, and functions.
  5. Submit Pull Request of your fork against master branch (or the branch of origin).

Getting the Source

Use git clones to get the source from your fork

$ git clone https://github.com/mygithubid/ctrace-go.git

or from the main repo.

$ git clone https://github.com/Nordstrom/ctrace-go.git

Initialize Project

Use make dependencies to initialize the project

make dependencies

Building and Testing Project

To lint the project run make lint

make lint

To test the project run make test

make test

To run bench marks run make bench

make bench