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

Update README.md #2707

Merged
merged 5 commits into from
Jul 18, 2024
Merged

Update README.md #2707

merged 5 commits into from
Jul 18, 2024

Conversation

namurphy
Copy link
Member

@namurphy namurphy commented May 30, 2024

Some updates to README.md, in progress. I'd like to condensify a bunch of sections in this, and refer people to the corresponding documentation pages. Putting the installation section closer to the top seems worthwhile too. I'd also like to have separate sections for submitting bug reports and making feature requests, with a link to how to join GitHub.

@github-actions github-actions bot added the maintenance General updates to package infrastructure label May 30, 2024
Copy link

codecov bot commented May 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.23%. Comparing base (2989cbf) to head (6f6396d).
Report is 1 commits behind head on main.

Current head 6f6396d differs from pull request most recent head ec7a8bd

Please upload reports for the commit ec7a8bd to get more accurate results.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2707   +/-   ##
=======================================
  Coverage   95.23%   95.23%           
=======================================
  Files         107      107           
  Lines        9597     9597           
  Branches     2221     2221           
=======================================
  Hits         9140     9140           
  Misses        273      273           
  Partials      184      184           

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

@namurphy namurphy added the status: on hold Issues & PRs that are being intentionally delayed label Jul 3, 2024
@namurphy
Copy link
Member Author

namurphy commented Jul 3, 2024

I'm waiting on this one until after #2742 is merged.

@namurphy namurphy marked this pull request as ready for review July 18, 2024 01:53
@namurphy namurphy requested a review from a team as a code owner July 18, 2024 01:53
@namurphy namurphy requested review from pheuer and removed request for a team and pheuer July 18, 2024 01:53
@namurphy namurphy merged commit 3f14188 into PlasmaPy:main Jul 18, 2024
14 of 16 checks passed
@namurphy namurphy deleted the readme-email branch July 18, 2024 01:53
@github-actions github-actions bot removed status: on hold Issues & PRs that are being intentionally delayed no changelog entry needed labels Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance General updates to package infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant