Skip to content

docs: explain role of mise and Renovate, add editorconfig#23

Merged
zeitlinger merged 3 commits intomainfrom
docs
Feb 17, 2026
Merged

docs: explain role of mise and Renovate, add editorconfig#23
zeitlinger merged 3 commits intomainfrom
docs

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

Summary

  • Add "How it works" section to README explaining the role of mise
    (tool installer + task runner) and Renovate (dependency updater +
    preset) for users new to the project
  • Add per-linter paragraphs describing how mise and Renovate interact
    with each task (super-linter, links, renovate-deps)
  • Add .editorconfig with line length limits (100 default, 120 for
    scripts, 300 for config files) mirroring prom_client_java setup
  • Wrap all README/CLAUDE.md prose to 100 chars, use
    editorconfig-checker-disable for tables and HTML that can't be
    shortened
  • Extract long shell/Python lines into intermediate variables to
    comply with editorconfig limits

Test plan

  • mise run lint passes locally
  • CI passes on this PR
  • Verify README renders correctly on GitHub (badges, tables, links)

- Add "How it works" section explaining mise (tool installer + task
  runner) and Renovate (dependency updater + preset)
- Add per-linter paragraphs describing how mise and Renovate interact
  with each task
- Add .editorconfig with line length limits (100 default, 120 for
  scripts, 300 for config files)
- Wrap all prose to 100 chars, use editorconfig-checker-disable for
  tables and HTML that can't be shortened
- Extract long shell/Python lines into intermediate variables
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
The HTML comment between </h1> and <p> broke badge rendering on
GitHub by splitting the HTML block.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Copilot AI review requested due to automatic review settings February 17, 2026 06:49
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 improves onboarding documentation for flint by explaining how mise (tool installer + task runner) and Renovate (dependency updater + preset) work together, and adds an .editorconfig to standardize line-length limits across the repo.

Changes:

  • Expanded README with a “How it works” section and per-task explanations of how mise and Renovate interact.
  • Wrapped prose to 100 chars, added editorconfig-checker-disable guards for sections that can’t reasonably conform (tables/HTML).
  • Added .editorconfig line-length limits and refactored a few long lines in scripts/config.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tasks/lint/renovate-deps.py Refactors env parsing into an intermediate variable to avoid long lines.
tasks/lint/links.sh Extracts the default regex into a variable to reduce line length and improve readability.
README.md Adds “How it works” + per-task mise/Renovate behavior; wraps prose and adds checker disable/enable markers.
CLAUDE.md Wraps the AUTOFIX convention description to comply with line-length constraints.
.github/renovate.json5 Collapses long arrays/strings to reduce formatting noise and align with new line-length policies.
.editorconfig Introduces repo-wide max line length rules (and indentation settings).

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

Comment thread .editorconfig
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger merged commit 4622dc8 into main Feb 17, 2026
7 checks passed
@zeitlinger zeitlinger deleted the docs branch February 17, 2026 07:13
This was referenced Apr 16, 2026
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.

2 participants