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

ci: code formatting #33

Merged
merged 4 commits into from
Sep 8, 2024

Conversation

p5quared
Copy link
Owner

@p5quared p5quared commented Sep 8, 2024

This PR resolves #32.

Summary by Sourcery

Enhance code formatting in the Apple Music Lua module and introduce a CI job for automatic code formatting using Stylua. Update documentation to guide contributors on local formatting practices.

Enhancements:

  • Improve code formatting in the lua/apple-music/init.lua file for better readability and consistency.

CI:

  • Add a new CI job to automatically format Lua files using Stylua, ensuring consistent code style across the project.

Documentation:

  • Update the README.md to include instructions for running Stylua locally before opening pull requests.

@p5quared p5quared self-assigned this Sep 8, 2024
@p5quared p5quared linked an issue Sep 8, 2024 that may be closed by this pull request
Copy link

sourcery-ai bot commented Sep 8, 2024

Reviewer's Guide by Sourcery

This pull request implements code formatting changes and adds a new GitHub Actions workflow for automatic code formatting. The main changes are in the Lua code style and the addition of a new CI job for running Stylua.

File-Level Changes

Change Details Files
Refactored Lua code formatting
  • Updated string quotation marks from single to double quotes
  • Reformatted multi-line string declarations
  • Adjusted indentation and line breaks for better readability
  • Reformatted function calls and table declarations
lua/apple-music/init.lua
Added new GitHub Actions workflow for code formatting
  • Created a new job called 'formatting' in the workflow
  • Added steps to run Stylua for automatic Lua code formatting
  • Configured the workflow to create a pull request with formatting changes
.github/workflows/lemmy-help.yml
Updated README with contribution guidelines
  • Added a note to run Stylua locally before opening pull requests
README.md

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.

@p5quared p5quared added the enhancement New feature or request label Sep 8, 2024
@p5quared p5quared merged commit d1ee74f into main Sep 8, 2024
3 checks passed
@p5quared p5quared deleted the 21-qol-code-formatting-config-for-better-consistency branch September 8, 2024 01:41
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 @p5quared - I've reviewed your changes and they look great!

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

QoL: Code formatting config for better consistency?
1 participant