Skip to content
This repository has been archived by the owner on Sep 28, 2024. It is now read-only.

Latest commit

 

History

History
59 lines (35 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 1.48 KB
Raw

Contributing

Contributions are welcome!

Contributions can be made via a Pull Request on GitHub.

Reporting an Issue

Please report issues via the issue tracker on GitHub. For security-related issues, please email the maintainer directly.

Pull Requests

  • Lint & format changes - Make sure you run make lint & make fmt before committing your code.

  • Add tests where appropriate - Make sure new features or bug fixes are covered by a test.

  • Document any change in behaviour - Make sure the README and any other relevant documentation are kept up-to-date.

  • Create topic branches - i.e feature/some-awesome-feature.

  • One pull request per feature

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Install project dependencies

make install

Running the tests

make test

Building the project

make build

Compiling the protocol buffers

make proto

⚠️ You will need to manually install the Protobuf Runtime before you can compile the protocol buffers.

Generating mocks

make mocks

Notes