Document Driver design documentation (best practice)
Open
Nobody has claimed this yet.
driver
enhancement
- Dominant language
- Python
- Stars
- 459
- Forks
- 359
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 73
Description
Notes from talking with @spauka and @WilliamHPNielsen
* Consistent naming of similar parameters across instruments
* Use of Array/MultiParameters
* Use of channels
* Driver review standard
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
Start with the issue notes from the discussions with @spauka and @WilliamHPNielsen, and determine where driver design guidance belongs in the project documentation. Document the listed practices—consistent parameter naming, Array/MultiParameters, channels, and the driver review standard; done means these four areas are covered as usable best-practice guidance.
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
- 30/100