cucumber / cucumber/godog

🔧 Integrate golangci-lint for Static Code Analysis

Open
#696 1 comment 2 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
2.7k
Forks
280
Avg merge
2d 20h
Merged PRs (30d)
2

Description

### 🤔 What's the problem you're trying to solve?

To improve code quality and maintain consistency across the project, I'd like to propose adding golangci-lint to our development workflow.

This tool helps catch common bugs, enforces style guidelines, and ensures adherence to Go best practices—all with minimal setup and configuration.

Why this matters:

- Identifies potential bugs early through static analysis
- Maintains consistent code style and formatting
- Reduces technical debt over time
- Speeds up code reviews with automated checks

Proposed steps:

- Add golangci-lint configuration file (.golangci.yml) to the root of the repository.
- Define rules and linters we want to enforce.
- Update documentation or contributing guide to include linting steps.
- Integrate it into the CI pipeline to auto-run checks on PRs.

Let me know your thoughts or if you'd like help setting up the initial config. 🚀

### ✨ What's your proposed solution?

Integrate the linter in the repository

### ⛏ Have you considered any alternatives or workarounds?

_No response_

### 📚 Any additional context?

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the repository root, the existing contributing documentation, and the CI pipeline configuration. Define the .golangci.yml rules, document how to run linting, and verify that the CI pipeline runs it successfully on pull requests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.