getlantern / getlantern/unbounded
Improve constructor API, make sense of client types
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 57
- Forks
- 1
- Avg merge
- 20h 26m
- Merged PRs (30d)
- 13
Description
Background discussion emerged in https://github.com/getlantern/broflake/pull/81
We should come up with more descriptive names than "widget" and "desktop," we should be clearer in code and documentation about the significance of client types, we should become clearer about whether Broflake is designed to let implementers build arbitrary clients out of lower level components or whether it's designed to enforce only a couple of higher level constructors, and we should expose simpler, higher order constructors to developers -- like NewBroflakeWidget and NewBroflakeDesktop.
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
Start with the background discussion in PR #81, then inspect the existing constructor API and how client types are named and documented. Done means the project has descriptive client-type names, a clear stance on composable versus higher-level constructors, and simpler constructors such as NewBroflakeWidget and NewBroflakeDesktop.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100