RocketChat / RocketChat/Rocket.Chat.ReactNative
chore: Add @rocket.chat/rest-typings
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.4k
- Forks
- 1.5k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 90
Description
When this repo was migrated to TS, we didn't have any source of truth to get REST API definitions from, so we just duplicated typings from the backend and adapted them a little bit to our repo.
https://github.com/RocketChat/Rocket.Chat.ReactNative/tree/develop/app/definitions
Let's refactor that to use this instead https://www.npmjs.com/package/@rocket.chat/rest-typings
I can't emphasize how important this work is and how much it's going to improve our app maintainability and readability.
Some work was done here, but the scope was bigger https://github.com/RocketChat/Rocket.Chat.ReactNative/pull/5918
Let's focus on this issue first and then we can focus that PR on migrating the SDK.
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 with the duplicated REST definitions under app/definitions and compare them with @rocket.chat/rest-typings. Review the scope and unfinished work in pull request #5918, then identify the app consumers that depend on those definitions. Done means the app uses the package as its REST API typing source without retaining the duplicated definitions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, mobile
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100