Skip to content
This repository has been archived by the owner on Aug 10, 2023. It is now read-only.

Latest commit

 

History

History
47 lines (31 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.41 KB

Contributing to Rotator

Thank you for taking the time to contribute to this project!

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

This project is licensed under the MIT license.

Reporting Bugs and Adding Functionality

We're excited you'd like to contribute to rotator!

When reporting a bug, please include:

  • Steps to reproduce
  • The version of rotator that you are using
  • A test case, if you are able

If you believe you have found a security issue, please contact us at [email protected] rather than filing an issue here.

When proposing new functionality, please include tests that cover the new behavior.

Local Development

  1. Install go
  2. Clone rotator locally:
❯ git clone https://github.com/chanzuckerberg/rotator.git
  1. Set up development dependencies
❯ make setup

Tests

Running Tests

You can run tests using make test.

To include integration tests, use make test-all instead. Integration tests rely on any external resources (e.g. AWS services) while unit tests rely on mocking.

To get accurate test coverage using goverage, use make test-coverage or make test-coverage-all.