Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flake-parts: update treefmt,pre-commit-hooks defaults & update github templates #31

Merged
merged 9 commits into from
Aug 7, 2024

Conversation

tsandrini
Copy link
Owner

@tsandrini tsandrini commented Aug 7, 2024

Overview

Testing

Dependencies

Screenshots

Checklist

  • I have tested the relevant changes locally.
  • I have checked that nix flake check passes.
  • I have ensured my commits follow the project's commits guidelines.
  • I have checked that the changes follow a linear history.
  • (If applicable) I have commented any relevant parts of my code.
  • (If applicable) I have added appropriate unit/feature tests.
  • (If applicable) I have updated the documentation accordingly (in English).

Additional Notes

Summary by Sourcery

Update GitHub templates for issues and pull requests, enhance treefmt and pre-commit-hooks configurations, and perform minor cleanup in configuration files.

Enhancements:

  • Update GitHub issue templates for bug reports and feature requests with improved formatting and clearer instructions.
  • Enable additional formatters and linters in treefmt configuration, including yamlfmt, jsonfmt, and shellcheck.
  • Adjust pre-commit hooks configuration to enable editorconfig-checker and commitizen, while commenting out actionlint and typos.

Chores:

  • Add shebang to .envrc file in flake-parts-bootstrap for better script execution.
  • Remove unnecessary blank lines in .github/dependabot.yml and .envrc files.

@tsandrini tsandrini self-assigned this Aug 7, 2024
Copy link

sourcery-ai bot commented Aug 7, 2024

Reviewer's Guide by Sourcery

This pull request updates the default configurations for treefmt and pre-commit-hooks, enhances GitHub issue templates with better formatting and emojis, and makes minor improvements to various configuration files. The changes include enabling additional formatters and tools, improving readability of issue templates, and disabling specific markdownlint rules in pull request templates.

File-Level Changes

Files Changes
.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
flake-parts/gh-templates-issues/.github/ISSUE_TEMPLATE/bug_report.md
flake-parts/gh-templates-issues/.github/ISSUE_TEMPLATE/feature_request.md
Updated issue templates to include emojis in titles and improved formatting for better readability.
flake-parts/treefmt/flake-parts/treefmt.nix
flake-parts/pre-commit-hooks/flake-parts/pre-commit-hooks.nix
Updated treefmt and pre-commit-hooks configurations to enable additional formatters and tools.
.github/PULL_REQUEST_TEMPLATE.md
flake-parts/gh-templates-PR/.github/PULL_REQUEST_TEMPLATE.md
Disabled markdownlint rule MD041 in pull request templates.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @tsandrini - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

flake-parts/treefmt/flake-parts/treefmt.nix Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
@tsandrini tsandrini merged commit 0f21b53 into main Aug 7, 2024
2 checks passed
@tsandrini tsandrini deleted the updates branch August 7, 2024 12:03
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.

1 participant