Visitar URL original
Use `pretty-format-yaml` pre-commit hook on `CITATION.cff` by namurphy · Pull Request #1773 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Use pretty-format-yaml pre-commit hook on CITATION.cff - #1773

Merged
StanczakDominik merged 2 commits into
PlasmaPy:mainfrom
namurphy:pretty-format-citation-cff
Oct 31, 2022
Merged

StanczakDominik merged 2 commits into
PlasmaPy:mainfrom
namurphy:pretty-format-citation-cff

Conversation

@namurphy

@namurphy namurphy commented Oct 31, 2022 •

Copy link
Copy Markdown
Member

CITATION.cff is a YAML file, but the pretty-format-yaml pre-commit hook does not get applied to it because it does not have the .yml or .yaml file extension. For this PR, I renamed CITATION.cff → CITATION.yaml, ran pre-commit run --all-files, and renamed CITATION.yaml → CITATION.cff. I only made formatting changes to this file.

@github-actions

Copy link
Copy Markdown

Thank you for contributing to PlasmaPy! The project's future depends deeply on contributors like you, so we deeply appreciate it! 🌱 The following checklist will be used by the code reviewer to help guide the code review process.

  • Overall
    • Does the PR do what it intends to do?
    • Except for very minor changes, is a changelog entry included and consistent with the changelog guide?
    • Are the continuous integration checks passing? (Most linter problems can be automagically fixed by commenting on this PR with pre-commit.ci autofix.)
  • Code
    • Is new/updated code understandable and consistent with the coding guide?
    • Are there ways to greatly simplify the implementation?
    • Are there any large functions that should be split up into shorter functions?
  • Tests
    • Are tests added/updated as required, and consistent with the testing guide?
    • Are the tests understandable?
    • Do the tests cover all important cases?
  • Docs
    • Are docs added/updated as required, and consistent with the doc guide?
    • Are the docs understandable?
    • Do the docs show up correctly in the preview, including Jupyter notebooks?

@codecov

codecov Bot commented Oct 31, 2022 •

Copy link
Copy Markdown

Codecov Report

Base: 98.36% // Head: 98.36% // No change to project coverage 👍

Coverage data is based on head (1e2f4d7) compared to base (941fcea).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1773   +/-   ##
=======================================
  Coverage   98.36%   98.36%           
=======================================
  Files          86       86           
  Lines        8176     8176           
=======================================
  Hits         8042     8042           
  Misses        134      134           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@namurphy namurphy added the no changelog entry needed For PRs that should not have a changelog entry label Oct 31, 2022
@namurphy
namurphy marked this pull request as ready for review October 31, 2022 16:14
@namurphy
namurphy requested a review from a team as a code owner October 31, 2022 16:14
@namurphy
namurphy requested review from StanczakDominik and removed request for a team October 31, 2022 16:14
@StanczakDominik
StanczakDominik merged commit 93ee556 into PlasmaPy:main Oct 31, 2022
@namurphy
namurphy deleted the pretty-format-citation-cff branch October 31, 2022 16:24
@namurphy

Copy link
Copy Markdown
Member Author

Thank you for the quick reviews!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no changelog entry needed For PRs that should not have a changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants