scverse / scverse/scverse-tutorials
Tutorial proposal: Best practices for being an ecosystem package
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 22
- Forks
- 18
- Avg merge
- 3h 9m
- Merged PRs (30d)
- 9
Description
There are often very non-obvious, but simple things that sometimes prevent ecosystem packages from "going mainstream". We should write a tutorial/guide on do's and don't's for building ecosystem packages.
I'm thinking here we can promote our template, but also make recommendations about requirements (don't pin versions, generally don't add unnecessary dependencies, etc etc), and some commentary on APIs.
Contributor guide
No contributing guide indexed for this repository
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
No file, test, or entry point is identified in the issue. Start by locating the tutorial documentation structure, then define a guide covering the package template, version pinning, unnecessary dependencies, and API recommendations. Done means the ecosystem package best-practices guide is added with those topics addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100