https://github.com/stoplightio/types
Common typings for the Stoplight ecosystem.
https://github.com/stoplightio/types
Last synced: about 1 year ago
JSON representation
Common typings for the Stoplight ecosystem.
- Host: GitHub
- URL: https://github.com/stoplightio/types
- Owner: stoplightio
- License: apache-2.0
- Created: 2018-10-09T23:41:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T07:07:23.000Z (over 1 year ago)
- Last Synced: 2025-04-05T22:43:24.718Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://stoplight.io
- Size: 1.15 MB
- Stars: 6
- Watchers: 17
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @stoplight/types
Common typings for the Stoplight ecosystem.
- Explore the interfaces: [TSDoc](https://stoplightio.github.io/types/)
- View the changelog: [Releases](https://github.com/stoplightio/types/releases)
### Dependent repositories:
https://github.com/stoplightio/types/network/dependents
### Installation
Supported in modern browsers and node.
```bash
# latest stable
yarn add -D @stoplight/types
```
### Contributing
1. Clone repo.
2. Create / checkout `feature/{name}`, `chore/{name}`, or `fix/{name}` branch.
3. Install deps: `yarn`.
4. Make your changes.
5. Run tests: `yarn test.prod`.
6. Stage relevant files to git.
7. Commit: `yarn commit`. _NOTE: Commits that don't follow the [conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional) format will be rejected. `yarn commit` creates this format for you, or you can put it together manually and then do a regular `git commit`_.
8. Push: `git push`.
9. Open PR targeting the `next` branch.