AllenInstitute / AllenInstitute/AllenSDK
Improve organization of AllenSDK APIs
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 398
- Forks
- 163
- PR merge metrics
- No merged PRs in 30d
Description
We recognize that the AllenSDK has evolved organically to support many varied projects and the current organization may not be sufficient to support existing and forthcoming projects in a manner that is easy to understand and maintain. This epic describes an effort to plan, design and implement an improved structure for AllenSDK APIs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
This is an epic to plan, design, and implement a new AllenSDK API structure, but it names no files, tests, or entry points. Start by identifying the existing API organization and the projects it must support; the work is done when an agreed structure is designed and implemented for maintainability.
Written by the indexing model from the issue text.
Assessment
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100