brookesb91 / brookesb91/sails-js
Improved documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Hey @brookesb91, I came across your repo recently when looking for some TS definitions for Sails. I see it's not maintained anymore, but I don't think much has changed in sails since.
I've been using Sails for a long time but only just switching to TypeScript. I was wondering whether you would be able to write some brief notes on how I can use these definitions in my app?
If it's not something you're interested in maintaining, let me know and I will create a fork and try to work it out! :)
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 reviewing the repository's TypeScript definitions and determine how they are intended to be used in a Sails application. Add brief usage notes for someone integrating the definitions into an app; completion means the setup and usage guidance is understandable without further clarification.
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
- 25/100