bgRun/bgRunMain are undocumented
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 73
- Forks
- 351
- Avg merge
- 5h 21m
- Merged PRs (30d)
- 9
Description
The background job service is useful and covers a lot of the same ground as https://github.com/spray/sbt-revolver but is undocumented. I think that sbt-revolver would be largely unnecessary in most projects if there was documentation of bgRun and bgRunMain and if ~ was made to work with them.
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
The issue names bgRun and bgRunMain but no files or tests; start by locating their existing documentation and command entry points, then compare the behavior with the referenced sbt-revolver tool. Done means both commands are documented and, if the behavior change is in scope, ~ works with them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100