Add/improve in-code documentation
Open
Nobody has claimed this yet.
1. to develop
technical debt
- Dominant language
- JavaScript
- Stars
- 1k
- Forks
- 348
- Avg merge
- 12h 28m
- Merged PRs (30d)
- 91
Description
That's true, many segments of our code are either only documented poorly or not documented at all. We can work on that ofc :-)
Originally posted by @ChristophWurst in https://github.com/nextcloud/mail/pull/271
In-code documentation helps other developers to understand other's code.
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
The issue does not name any files, tests, or entry points. Start by identifying code areas with missing or poor in-code documentation, then confirm the scope with maintainers before choosing a focused area. Done means the selected code is documented clearly enough for other developers to understand it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100