Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 2.84 KB
Raw

Contributing

Issues, whether bugs, tasks, or feature requests are essential for keeping pluto great. We believe it should be as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can keep on top of things.

Code of Conduct

This project adheres to a code of conduct. Please review this document before contributing to this project.

Sign the CLA

Before you can contribute, you will need to sign the Contributor License Agreement.

Project Structure

CLI

pluto is a relatively simple cobra cli tool that helps deal with deprecated api versions in Kubernetes. The /cmd folder contains the flags and other cobra config, while the /pkg folder has the various packages.

API

This contains the various structs and helper functions to deal with Kubernetes objects and their apiVersions. It assumes that any file we care about will have a Kind and an apiVersion.

Finder

This package is for dealing with a set of static files and analyzing the apiVersions in them. It can search through a directory and find any files that conform to the specifications of the versions package.

Getting Started

We label issues with the "good first issue" tag if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up.

Setting Up Your Development Environment

Prerequisites

  • A properly configured Golang environment with Go 1.13 or higher

Installation

  • Clone the project with go get github.com/fairwindsops/pluto
  • Change into the pluto directory which is installed at $GOPATH/src/github.com/fairwindsops/pluto
  • Use make build to build the binary locally.
  • Use make test to run the tests and generate a coverage report.

Creating a New Issue

If you've encountered an issue that is not already reported, please create an issue that contains the following:

  • Clear description of the issue
  • Steps to reproduce it
  • Appropriate labels

Creating a Pull Request

Each new pull request should:

  • Reference any related issues
  • Add tests that show the issues have been solved
  • Pass existing tests and linting
  • Contain a clear indication of if they're ready for review or a work in progress
  • Be up to date and/or rebased on the master branch

Creating a new release

Push a new annotated tag. This tag should contain a changelog of pertinent changes. Goreleaser will take care of the rest.

Pre-commit

This repo contains a pre-commit file for use with pre-commit. Just run pre-commit install and you will have the hooks.