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

Add "making test data files" section to contributing guide #233

Merged
merged 4 commits into from
Feb 28, 2024

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Feb 28, 2024

Closes #128.

Progress of the PR

  • Explain how user can make good test data files and the rational,
  • [n/a] update docstring (if appropriate),
  • update contributing guide (if appropriate),
  • add a changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting of the changelog entry (and eventual user guide changes) in the docs/readthedocs.org:rosettasciio build of this PR (link in github checks)
  • [n/a] add tests,
  • ready for review.

@ericpre ericpre requested a review from jlaehne February 28, 2024 09:18
@ericpre ericpre added this to the v0.4 milestone Feb 28, 2024
@ericpre ericpre added documentation Improvements or additions to documentation type: enhancement labels Feb 28, 2024
Copy link

codecov bot commented Feb 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.25%. Comparing base (531dbf8) to head (ca8bd82).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #233   +/-   ##
=======================================
  Coverage   86.25%   86.25%           
=======================================
  Files          82       82           
  Lines       10561    10561           
  Branches     2295     2295           
=======================================
  Hits         9109     9109           
  Misses        934      934           
  Partials      518      518           

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

@jlaehne jlaehne merged commit 5922062 into hyperspy:main Feb 28, 2024
28 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation type: enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add information on providing small test dataset in CONTRIBUTING.rst
2 participants