RocketChat / RocketChat/Rocket.Chat
Documentation: Missing README.md and package descriptions in monorepo
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 46.1k
- Forks
- 13.9k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 130
Description
Several packages and apps in the monorepo are missing foundational documentation, specifically 'README.md' files and 'description' fields in 'package.json'. This makes it difficult for new contributors to understand the purpose and usage of these components.
Affected components identified so far:
- 'packages/web-ui-registration' (Missing README.md)
- 'packages/favicon' (Missing description in package.json)
- 'apps/uikit-playground' (Missing description in package.json)
I will be submitting a PR to address these specific gaps.
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
Review the package contents and nearby documentation conventions for packages/web-ui-registration, packages/favicon, and apps/uikit-playground. Add the missing README.md or package.json description named for each component, and consider the work done when all three identified documentation gaps are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100