Skip to content

Latest commit

 

History

History
152 lines (108 loc) · 5.49 KB

CONTRIBUTING.md

File metadata and controls

152 lines (108 loc) · 5.49 KB
Raw

Contributing to linode-cosi-driver

Table of Contents

First: if you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. You won't be yelled at for giving your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate all contributions!

For those folks who want a bit more guidance on the best way to contribute to the project, read on. Addressing the points below lets us merge or address your contributions quickly.

Issues

Reporting an Issue

  • Make sure you test against the latest released version. It is possible we already fixed the bug you're experiencing.
  • If you experienced a panic, please create a gist of the entire generated crash log for us to look at. Double check no sensitive items were in the log.
  • Respond as promptly as possible to any questions made by the linode-cosi-driver team to your issue. Stale issues will be closed.

Issue Lifecycle

  1. The issue is reported.
  2. The issue is verified and categorized by a linode-cosi-driver collaborator. Categorization is done via labels. For example, bugs are marked as "bugs".
  3. Unless it is critical, the issue is left for a period of time (sometimes many weeks), giving outside contributors a chance to address the issue.
  4. The issue is addressed in a pull request. The issue will be referenced in commit message(s) so that the code that fixes it is clearly linked.
  5. The issue is closed. Sometimes, valid issues will be closed to keep the issue tracker clean. The issue is still indexed and available for future viewers, or can be re-opened if necessary.

Pull Requests

Pull requests must always be opened from a fork of linode-cosi-driver, even if you have commit rights to the repository so that all contributors follow the same process.

Developing

Go Environment and Go Modules

To contribute to linode-cosi-driver, you need to have Go installed on your system and set up with Go modules. Follow these steps to get started:

  1. Install Go:

    • For macOS users, the recommended way is to use Homebrew: 
      $ brew install go
    • For other platforms or manual installation, you can download and install Go from the official website.

  2. Clone the linode-cosi-driver repository to your local machine:

    $ git clone https://github.com/linode/linode-cosi-driver.git

  3. Change into the linode-cosi-driver directory:

    $ cd linode-cosi-driver

  4. Now you're all set with the Go environment and Go modules!

Code Linting with golangci-lint

To ensure consistent code quality, we use golangci-lint as a single point for code linting. You can install golangci-lint via Homebrew (for macOS users) or using the go install command (for all platforms).

Installing golangci-lint via Homebrew (macOS)

If you're on macOS and using Homebrew, you can install golangci-lint with the following command:

$ brew install golangci-lint

Make sure to update golangci-lint regularly to get the latest improvements:

$ brew upgrade golangci-lint

Installing golangci-lint via go install

For other platforms, you can install golangci-lint using the go install command:

$ go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Ensure that your Go binary is in your system's PATH for the go install command to work correctly.

With golangci-lint installed, you can now run it against the linode-cosi-driver codebase to check for any linting issues:

$ golangci-lint run

Fix any linting issues reported by golangci-lint before submitting your changes.

Remember, we encourage contributions to be well-formatted and follow the project's coding conventions. Happy coding!

Testing

Writing Tests

When adding new features or fixing bugs, it's essential to write tests to ensure the stability and correctness of the code changes. linode-cosi-driver uses both unit tests and integration tests.

Unit tests

Unit tests focus on testing individual functions and components in isolation. To write a unit test, create a new file in the *_test.go format alongside the code you want to test. Use the Go testing framework to create test functions that cover different scenarios and edge cases.

Example unit test:

import (
    "testing"
)

func TestAdd(t *testing.T) {
    expected := 5

    result := Add(2, 3)
    if result != expected {
        t.Errorf("expected %d, but got %d", expected, result)
    }
}
End-to-end tests

Our end-to-end tests are located in a dedicated directory (test/e2e). These tests are written using Behavior-Driven Development (BDD) principles, employing the Ginkgo testing framework and Gomega assertion library.