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

Latest commit

 

History

History
52 lines (30 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 3.96 KB
Raw

Contributing Guidelines

Read the following guide if you're interested in contributing to Ingress. Make Ingress-Nginx Work for you, and the Community from KubeCon Europe 2018 is a great video to get you started!!

Note that this guide refers to contributing to actual sources of the repository. If you interested in contributing through issue triaging, have a look at this guide.

Contributor License Agreements

We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA).

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.

Finding Issues That Need Help

If you're new to the project and want to help, but don't know where to start, we have a semi-curated list of issues that should not need deep knowledge of the system. Have a look and see if anything sounds interesting.

Alternatively, search for the label triage-accepted if you have some experience with ingress-nginx. Note, that it could make sense to grab issues with higher priority first.

Contributing a Patch

  1. If you haven't already done so, sign a Contributor License Agreement (see details above).
  2. Read the Ingress development guide.
  3. Fork the desired repo, develop and test your code changes.
  4. Submit a pull request.

All changes must be code reviewed. Coding conventions and standards are explained in the official developer docs. Expect reviewers to request that you avoid common go style mistakes in your PRs.

Merge Approval

Ingress Nginx collaborators may add "/lgtm" (Looks Good To Me) to indicate that a PR is acceptable. Any change requires at least one LGTM. No pull requests can be merged until at least one Ingress Nginx collaborator signs off with an LGTM. Adding the "/lgtm" comment result in the prow bot adding the lgtm label. Note that a pull request still needs an approve label from one of the owners.

Reviewers or members who want to become reviewers according to the k8s membership ladder, could actively search for pull requests that need a review.

Support Channels

Whether you are a user or contributor, official support channels include:

Before opening a new issue or submitting a new pull request, it's helpful to search the project - it's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of.

New Contributor Tips

If you're a new contributor, you can follow the New Contributor Tips guide