Document conventions for symbol usage and aliases
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
I think we've kind of settled on using the non-symbolic form of operators and types even when a symbolic form is provided as an alias. This tends to make it less bewildering and easier to google or ask questions about for newcomers. But I can't seem to find anywhere that we have documented this convention in the contributor guide. We should probably do that.
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 locating the contributor guide in the repository and review its existing conventions sections. Document the convention of using non-symbolic operator and type forms when symbolic aliases exist; it is done when contributors can find and understand this guidance there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100