Imageomics / Imageomics/TreeOfLife-toolbox

Documentation Review

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

Nobody has claimed this yet.

documentation
Dominant language
Jupyter Notebook
Stars
7
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Make sure that when someone installs the package, it is runable---need not be perfect, but should work!

Clarity of integration/reliance on distributed-downloader:

  • status at handoff (i.e., what does the data look like after this process---as in what should it look like coming into this)

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 installing the package and reviewing the distributed-downloader-tools portion of the linked comment. Document the expected data at handoff and confirm that the installed package runs and that its integration with distributed-downloader is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.