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

[DOC] update readme #7

Merged
merged 3 commits into from
Aug 15, 2024
Merged

[DOC] update readme #7

merged 3 commits into from
Aug 15, 2024

Conversation

Remi-Gau
Copy link
Contributor

@Remi-Gau Remi-Gau commented Aug 14, 2024

quick clean up of the README

left some things commented as I do not know if they apply (for example: passing a config to the bids validator)

rendered version: https://github.com/Remi-Gau/python-validator/blob/readme/README.md

Copy link

codecov bot commented Aug 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.90%. Comparing base (9acd81f) to head (a0c40bd).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #7   +/-   ##
=======================================
  Coverage   85.90%   85.90%           
=======================================
  Files           3        3           
  Lines         149      149           
  Branches       43       43           
=======================================
  Hits          128      128           
  Misses          9        9           
  Partials       12       12           

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

@Remi-Gau
Copy link
Contributor Author

more possible changes:

  • remove contributors as they correspond to those in the javascript validator
  • remove zenodo.json for the same reason

@Remi-Gau
Copy link
Contributor Author

is this failing because I opened the PR from a fork?

https://github.com/bids-standard/python-validator/actions/runs/10384933325/job/28752987383?pr=7

@effigies
Copy link
Contributor

Seems plausible. I can try disabling that on forks.

Copy link
Contributor

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Initial comments

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Remi-Gau
Copy link
Contributor Author

will merge and we can revert or iterate on this

@Remi-Gau Remi-Gau merged commit b824917 into bids-standard:main Aug 15, 2024
31 checks passed
@Remi-Gau Remi-Gau deleted the readme branch August 15, 2024 11:50
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