HangfireIO / HangfireIO/Hangfire
API documentation comments
- Dominant language
- C#
- Stars
- 10.1k
- Forks
- 1.8k
- Avg merge
- 1h 19m
- Merged PRs (30d)
- 1
Description
It would be useful if the properties and classes had their xmldoc comments.
Many classes could really benefit from this and it shouldn't be much work for somebody who actually understands Hangfire deeply.
I know about the [api.hangfire.io](api.hangfire.io) project, but the documentation there is just not sufficient.
It makes me think if the poor documentation isn't a business decision to make users pay for plans with support.
Anyway, Hangfire is an amazing product and I believe this would improve it without much effort. How about starting with the basic configuration classes like `SqlServerStorageOptions`, `BackgroundJobServerOptions`, `DashboardOptions`?
Contributor guide
Research direction
Start by locating the basic configuration classes named in the issue: SqlServerStorageOptions, BackgroundJobServerOptions, and DashboardOptions. Review their public classes and properties, along with the existing API documentation conventions. Done means those types and members have useful XML documentation comments suitable for the generated API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100