Add README.md files to important directories
#2742
Conversation
github-actions
bot
added
the
maintenance
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2742 +/- ##
==========================================
+ Coverage 94.44% 95.23% +0.79%
==========================================
Files 107 107
Lines 9597 9597
Branches 2221 2221
==========================================
+ Hits 9064 9140 +76
+ Misses 343 273 -70
+ Partials 190 184 -6 ☔ View full report in Codecov by Sentry. |
As requested by Erik in PlasmaPy#2647.
| ### Suggestion box | ||
|
|
||
| We have a [suggestion box] if you would like to (optionally | ||
| anonymously) suggest a feature/topic for consideration. These | ||
| suggestions might be changed into GitHub issues for further | ||
| discussion. | ||
|
|
There was a problem hiding this comment.
Removing this since it's been pretty rare for us to get suggestions in the suggestion box.
| # Allow contributors to create a custom requirements.txt file for | ||
| # their own use. | ||
| requirements.txt | ||
|
|
README.md
Outdated
| > top-level [`tests/`] directory. Existing pull requests should pull | ||
| > in the changes from the `main` branch with `git pull upstream main` | ||
| > (assuming the remote for the primary PlasmaPy repo is named | ||
| > `upstream`). Because `git` does not automatically remove | ||
| > directories, the `plasmapy/` directory in older clones must be | ||
| > manually deleted. If you previously did an editable installation of | ||
| > PlasmaPy, it will likely need to be redone by running `pip install | ||
| > -e .[tests,docs]` in the top-level directory of the repository. |
There was a problem hiding this comment.
🎨 I only justified the text here. No substantive changes.
| PlasmaPy can also be installed using [Anaconda Navigator] so long as | ||
| `conda-forge` is added as a channel. |
There was a problem hiding this comment.
The licensing for Anaconda Navigator has gradually been becoming more restrictive, so I'm leaning against including it in README.md (though it should be discussed in the online documentation).
| If you have [installed Conda], then you can also install PlasmaPy into | ||
| an activated Conda environment by running: |
There was a problem hiding this comment.
😅 One of the steps I take when editing a document is to remove as many occurrences of "also" as I can!
namurphy
changed the title
README.md files to important directories
github-actions
bot
added
GitHub Actions
github-actions
bot
added
CI
There was a problem hiding this comment.
I've been noticing that most PRs that get submitted end up deleting the suggested sections of the pull request template, including most of the PRs that I submit! This PR reduces the amount of information to the essentials, which incidentally makes it easier to delete!
(A bit of scope creep for this PR, but it's still related to the main idea.)
There was a problem hiding this comment.
I've noticed that when most contributors make pull requests (including me!), the pull request template gets deleted. Drastically shortening the template will make it more likely that the contents actually do get read (in particular the link to the contributor guide)...and it'll also make it easier to delete!
(This was a bit of scope creep for this PR, but it still fits in with the general idea.)
github-actions
bot
removed
the
status: ready for review
If a directory has a
README.mdfile, it shows up as documentation when you navigate to that directory on GitHub. I decided that it would be worthwhile to addREADME.mdfiles to our most important directories ahead of the summer school. This way, new contributors would be able to quickly get some idea of what the contents of the directory are for.My hope is to keep these succinct and refer people to the appropriate pages in the contributor guide so that we don't need to spend much time maintaining this. I'm definitely open to ways to shorten the content.
The files I added were:
src/plasmapy/README.mdtests/README.mddocs/README.mdtype_stubs/README.mdIn addition, I updated the primary
README.mdwith some minor fixes (fixing broken badges, removing redundant text, and dropping mention of Anaconda Navigator because it has new license restrictions).I also added
requirements.txtto.gitignore(as requested in #2647) so that contributors can use that file to define their own environments and that this file doesn't accidentally get committed.