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

Add a .gitattributes file #2331

Merged
merged 7 commits into from Sep 9, 2023
Merged

Add a .gitattributes file #2331

merged 7 commits into from Sep 9, 2023

Conversation

namurphy
Copy link
Member

@namurphy namurphy commented Sep 6, 2023

This PR adds a .gitattributes file to our repository. The main benefits are:

  • Consistency in line endings between different text files
  • Better git diff headers for providing context to changes

This PR also makes some minor edits to .editorconfig (see also #2129), and changes some files to make sure that the line endings are consistent.

@github-actions
Copy link

github-actions bot commented Sep 6, 2023

Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱

Our contributor guide has information on:

The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:

  • Try fixing CI / Python 3.11 test failures first.
  • Most pre-commit.ci - pr failures can be automagically fixed by commenting pre-commit.ci autofix below, followed by a git pull to bring the changes back to your computer.
  • If pre-commit.ci - pr says that a function is too long or complex, try breaking up that function into multiple short functions that each do one thing. See also these tips on writing clean scientific software.
  • If the CI / Documentation check ends with a cryptic error message, check out our documentation troubleshooting guide.
  • For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few days, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples.

We thank you once again!

@github-actions github-actions bot added docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.formulary Related to the plasmapy.formulary subpackage testing plasmapy.utils Related to the plasmapy.utils subpackage labels Sep 6, 2023
Copy link
Member Author

Choose a reason for hiding this comment

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

The only changes in this file are line endings (CRLF → LF).

Copy link
Member Author

Choose a reason for hiding this comment

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

The only changes in this file are line endings (CRLF → LF).

Copy link
Member Author

Choose a reason for hiding this comment

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

The only changes in this file are line endings (CRLF → LF).

*.json text
*.md text diff=markdown
*.py text diff=python
*.pyx text diff=python
Copy link
Member Author

Choose a reason for hiding this comment

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

Cython files (.pyx) are pretty close to Python, so the diff should work fine.

@namurphy namurphy marked this pull request as ready for review September 6, 2023 23:00
@namurphy namurphy requested a review from a team as a code owner September 6, 2023 23:00
@namurphy namurphy requested review from JaydenR2305 and removed request for a team September 6, 2023 23:00
@namurphy namurphy added the PDD label Sep 6, 2023
@codecov
Copy link

codecov bot commented Sep 6, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (6e63ba4) 98.35% compared to head (81e22dc) 98.35%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2331   +/-   ##
=======================================
  Coverage   98.35%   98.35%           
=======================================
  Files         100      100           
  Lines        8567     8567           
=======================================
  Hits         8426     8426           
  Misses        141      141           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@namurphy namurphy added no changelog entry needed status: ready for review PRs that are ready for code review labels Sep 6, 2023
@namurphy namurphy merged commit 55aa520 into PlasmaPy:main Sep 9, 2023
15 checks passed
@namurphy namurphy deleted the gitattributes branch September 9, 2023 20:30
@github-actions github-actions bot removed the status: ready for review PRs that are ready for code review label Sep 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org no changelog entry needed plasmapy.formulary Related to the plasmapy.formulary subpackage plasmapy.utils Related to the plasmapy.utils subpackage testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant