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 #84

Merged
merged 2 commits into from
Jul 31, 2022
Merged

Update README.md #84

merged 2 commits into from
Jul 31, 2022

Conversation

TomDonoghue
Copy link
Contributor

Thanks for contributing. If this is your first time,
make sure to read the contributing guide.

PR Description

As I was looking through the repository related to the JOSS review, there were a couple small README comments that seemed easier to suggest in a PR than a list of suggestions.

Please feel free to edit and updates things from this initial suggestion, the main points I wanted to address are:

  • updating some of the phrasing that felt a bit awkward
  • noting more explicitly in the install that there is a stable release available through pip (since it only mentions dev)
  • fixing a dead link for the contributing guidelines

Merge checklist

Maintainer, please confirm the following before merging:

  • All comments resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated
  • PR description includes phrase "closes <#issue-number>"

README.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jul 31, 2022

Codecov Report

Merging #84 (840cb23) into main (2ddc063) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #84   +/-   ##
=======================================
  Coverage   90.63%   90.63%           
=======================================
  Files          23       23           
  Lines         897      897           
=======================================
  Hits          813      813           
  Misses         84       84           

Help us with your feedback. Take ten seconds to tell us how you rate us.

@adam2392 adam2392 merged commit c0ddd1e into mne-tools:main Jul 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants