py4dstem / py4dstem/py4DSTEM

v15 tests refactor

Open
#619 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

v15
Dominant language
Python
Stars
279
Forks
177
PR merge metrics
No merged PRs in 30d

Description

  • clarify test dataset pipeline and update instructions in tests/README
  • clarify protocols for downloading test data, running tests, adding new tests, extending existing tests, adding new test datasets
  • verify function of basic testing framework

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading tests/README and tracing the test dataset pipeline and basic testing framework it describes. Clarify the documented procedures for downloading data, running tests, adding tests, extending tests, and adding datasets; done means the instructions are clear and the basic framework has been verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing-qa
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.