Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 3.2 KB
Raw

Contribution guidelines to the Sail Operator project

So you want to make contributions to the Sail Operator project, please take a look at the following guidelines to help you get started.

Table of Contents

Code of Conduct

As a contributor, you are expected to adhere to the Code of Conduct from CNCF as Istio community does. Please read the Code of Conduct before contributing to the project.

Contributing to the Sail Operator

We are open to contributions from the community. If you want to contribute to the Sail Operator project, you can start by opening a new issue in the Sail Operator GitHub repository or starting a discussion in the Sail Operator Discussion. You can also join the Istio Slack workspace by visiting the Istio Slack invitation page and finding the #sail-operator channel.

Way of Working

If you want to contribute to the Sail Operator project, you can follow some rules that we have defined to help you get started:

  • Discuss your changes before you start working on them. You can open a new issue in the Sail Operator GitHub repository or start a discussion in the Sail Operator Discussion. By this way, you can get feedback from the community and ensure that your changes are aligned with the project goals.
  • Use of Labels: We use labels in the issues to help us track the progress of the issues. You can use the labels to help you understand the status of the issue and what is needed to move forward. Those labels are:
    • backport/backport-handled: Use this label to indicate that the issue has been backported to the appropriate branches.
    • test: Use this label to indicate that the issue is related to test or add test-needed when a issue needs a test to be added related. Can be used in combination with other labels to mark the proper test type, for example: test-e2e, test-unit, test-integration.
    • good first issue: Use this label to indicate that the issue is a good first issue for new contributors.
    • help wanted: Use this label to indicate that the issue needs help from the community.
    • enhancement: Use this label to indicate that the issue is an enhancement related to a new feature or improvement.

Community meetings

This is not defined yet. We are working on defining the community meetings and how the community can participate in them. We will update this section once we have more information.

Security Issues

If you find a security issue in the Sail Operator project, please refer to the Security Policy for more information on how to report security issues. Please do not report security issues in the public GitHub repository.