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: improve wording #7550

Open
wants to merge 2 commits into
base: maint
Choose a base branch
from
Open

Conversation

alliesw
Copy link

@alliesw alliesw commented Jan 24, 2024

Provided a more comprehensive overview description. The current README.md is overflowing with commas, unnecessary information, and is overall worded poorly.

The entire README.md should be revised to read more comprehensively.

PR checklist

  • Provide an overview of the changes you're making and explain why you're proposing them.
  • Create a changelog snippet (add the CHANGELOG-missing label to this pull request in order to have a snippet generated from its title;
    or use scriv create locally and include the generated file in the pull request, see scriv).
  • Include Fixes #NNN somewhere in the description and scriv changelog entry if this PR addresses an existing issue.
  • If this PR is not complete, select "Create Draft Pull Request" in the pull request button's menu.
    Consider using a task list (e.g., - [ ] add tests ...) to indicate remaining to-do items.
  • If you would like to list yourself as a DataLad contributor and your name is not mentioned please modify .zenodo.json file.
  • Delete these instructions. :-)

Thanks for contributing!

Provided a more comprehensive overview description. The current README.md is overflowing with commas, unnecessary information, and is overall worded poorly. 

The entire README.md should be revised to read more comprehensively.
Copy link

codecov bot commented Jan 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (08315c1) 91.16% compared to head (4abd2b2) 90.59%.

Additional details and impacted files
@@            Coverage Diff             @@
##            maint    #7550      +/-   ##
==========================================
- Coverage   91.16%   90.59%   -0.57%     
==========================================
  Files         325      325              
  Lines       43440    43436       -4     
  Branches     5785        0    -5785     
==========================================
- Hits        39600    39352     -248     
- Misses       3825     4084     +259     
+ Partials       15        0      -15     

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

@yarikoptic
Copy link
Member

As a non-native English speaker it is hard for me to give adequate judgement to proposed changes. But I would like to thank you first of all for the attempt ;-)

@yarikoptic yarikoptic added the semver-documentation Changes only affect the documentation, no impact on version label Jan 24, 2024
@yarikoptic yarikoptic changed the title Update README.md Update README.md: improve wording Jan 24, 2024
@yarikoptic yarikoptic added the CHANGELOG-missing When a PR's description does not contain a changelog item, yet. label Jan 24, 2024
@github-actions github-actions bot removed the CHANGELOG-missing When a PR's description does not contain a changelog item, yet. label Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-documentation Changes only affect the documentation, no impact on version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants