leopardslab / leopardslab/react-email
[Docs] Improve Docs with the problem statement
Open
Nobody has claimed this yet.
Beginner Friendly
documentation
good first issue
hacktoberfest
help wanted
- Dominant language
- TypeScript
- Stars
- 48
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Description:
- We need to describe the problem we're solving and also the solution on how our package is solving that particular problem.
Outcome:
- Detailed writeup about the problem and the approach for the solution in the
README.mdfile.
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
Start by reading the existing README.md and the repository description to understand the package's purpose. Use the issue's requested problem statement and solution approach as the scope; done means README.md contains a detailed explanation of both.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100