purescript / purescript/pursuit
Use PURSUIT.md instead of README if it is present
Open
Nobody has claimed this yet.
needs-compiler-changes
- Dominant language
- Haskell
- Stars
- 174
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
I remember talking about this somewhere so apologies if it's a duplicate - I couldn't see one anywhere.
I suggest an easy quick-fix for this would be to remove sections in the markdown that start with the title Module documentation.
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 inspecting how README and PURSUIT.md are handled, including markdown sections titled Module documentation. Clarify whether PURSUIT.md should replace README whenever present or whether those sections should be removed; done means the intended behavior is implemented and verified for both files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100