AllenInstitute / AllenInstitute/ConnectsCommonConnectivity

Test-writing conventions + skill

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

Nobody has claimed this yet.

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

Description

Establish testing conventions and encode them as a reusable skill: consistent error raising and warning patterns, descriptive docstrings, test-first scaffolding for new io features (first consumer: #21).

References: planning/test_suite_analysis_2026-08-15.md (healthy 169-test pyramid; top gaps: CI enforcement, coverage measurement, direct arrow_utils tests, deeper parquet-loader cases, CLI behavioral tests) and planning/20260623/tests_review/findings.md. Gap items can become checkboxes here or follow-up issues.

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 planning/test_suite_analysis_2026-08-15.md and planning/20260623/tests_review/findings.md, then review the needs of the first consumer in issue #21. Use the listed gaps to determine the scope of the conventions and reusable skill; done should include agreed patterns and test-first scaffolding for new IO features.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.