Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 3.25 KB
Raw

Contributing to Containership

Thanks for checking out Containership! We're excited to hear and learn from you. Your experiences will benefit others who use it.

We've put together the following guidelines to help you figure out where you can best be helpful.

Table of Contents

  1. Types of contributions we're looking for
  2. Getting Help
  3. Ground rules & expectations
  4. How to contribute
  5. Style guide
  6. Setting up your environment
  7. Community

Types of contributions we're looking for

There are many ways you can directly contribute to the guides (in descending order of need):

  • Documentation
  • Fix editorial inconsistencies or inaccuracies
  • Feature enchancements

Interested in making a contribution? Read on!

Getting Help

If you have questions, issues, or want to know how best to contribute, you can create an issue in this repo.

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
  • When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, open a pull request.

Style guide

golanglint-ci will run for every PR commit. If there are linting failures, you will need to address them before we can merge your contribution.

Setting up your environment

The easiest and fastest way to get your environment up and running is to use the include DevContainer with Visual Studio Code. Here is a guide to get started.

If you wish to set up an environment manually, please follow Operator SDK's installation guide.

Community

Discussions about Containership take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.