Decide on Process API design
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 71
- Forks
- 27
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 33
Description
How should Process’s API be designed? Should it be explicit or implicit, and how should _ or __ be used to indicate private members?
How does internal Process modelling usage (e.g. from a notebook) differ from Bluemira’s requirements in an API?
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 by comparing Process’s internal modelling usage, including notebook use, with Bluemira’s API requirements. A decision is complete when the API’s explicit versus implicit design and the convention for marking private members with _ or __ are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100