Chore: create an issue template or contributing guidelines
Open
Nobody has claimed this yet.
chore
- Dominant language
- JavaScript
- Stars
- 1.9k
- Forks
- 51
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
We occasionally get issues filed at shx which are best directed at shelljs. It would be nice to have an issue template, or contributing guidelines, to instruct users to consider filing their issue at shelljs instead. Of course, some issues deserve to be directed here at shx.
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
Start by reviewing the shx issue intake and its relationship to shelljs, then determine whether an issue template or contributing guidelines best explains where reports belong. Done means users are directed to shelljs when appropriate while issues that belong to shx remain supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100