purescript-contrib / purescript-contrib/setup-purescript
Add documentation explaining the internals
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 46
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
This project currently doesn't meet the minimum requirements for libraries in the Contributors organization because it doesn't contain any tests or documentation. Lacking tests and documentation means it is harder for new contributors to understand the code and contribute safely.
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 repository implementation and identifying the internals that new contributors need to understand; the issue names no files, entry points, or tests. Done means adding documentation that explains those internals clearly and addresses the stated contributor requirements, with the requested test coverage considered separately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, javascript
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100