Skip to content

docs: simplify linting section in CONTRIBUTING.md#1054

Merged
zeitlinger merged 3 commits into
mainfrom
docs/simplify-linting-contributing
Feb 16, 2026
Merged

docs: simplify linting section in CONTRIBUTING.md#1054
zeitlinger merged 3 commits into
mainfrom
docs/simplify-linting-contributing

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

Summary

  • Replaces the detailed "Linting" and "Renovate Dependency Tracking" sections with a concise reference to flint, which now documents all of this
  • Keeps the essential mise run fix / mise run lint commands for quick reference
  • Removes unused [renovate] link reference

Related

Test plan

  • Verify the flint link resolves correctly
  • Confirm no other docs reference the removed "Renovate Dependency Tracking" section heading

Reference flint README instead of duplicating linting and Renovate
dependency tracking documentation.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Copilot AI review requested due to automatic review settings February 16, 2026 15:35
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR simplifies the linting documentation in CONTRIBUTING.md by replacing detailed sections on linting and Renovate dependency tracking with a concise reference to flint, which now serves as the central documentation source for all linting details. This reduces documentation duplication and maintenance burden.

Changes:

  • Replaced detailed linting instructions with a reference to flint's README for comprehensive documentation
  • Consolidated commands into a simple code block showing mise run fix and mise run lint with inline comments
  • Removed the "Renovate Dependency Tracking" section as it's now documented in flint
  • Removed unused [renovate] link reference

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
…rrors

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
zeitlinger added a commit to grafana/flint that referenced this pull request Feb 16, 2026
…ent (#14)

## Summary

- Adds an "Example" section to the README pointing to
[grafana/docker-otel-lgtm](https://github.com/grafana/docker-otel-lgtm)
as a real-world project using flint
- Links to its
[CONTRIBUTING.md](https://github.com/grafana/docker-otel-lgtm/blob/main/CONTRIBUTING.md)
(developer workflow) and
[mise.toml](https://github.com/grafana/docker-otel-lgtm/blob/main/mise.toml)
(task wiring)
- Removes the "Remind to reopen PR for CI" step from the release-please
workflow, since this is already documented in the README

## Related

A companion PR in docker-otel-lgtm simplifies its CONTRIBUTING.md to
reference flint instead of duplicating linting/Renovate documentation:
grafana/docker-otel-lgtm#1054

## Test plan

- [ ] Verify links in the new section resolve correctly

---------

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger merged commit 8dbb5ef into main Feb 16, 2026
9 checks passed
@zeitlinger zeitlinger deleted the docs/simplify-linting-contributing branch February 16, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants