ut-tools
Version:
Build and Release management automation package.
42 lines (28 loc) • 972 B
Markdown
# @stoplight/path
<!-- BADGES -->
<!-- SUMMARY -->
- View the changelog: [Releases](https://github.com/stoplightio/path/releases)
### Features
- **Awesome**: It is.
- .. more features
### Installation
Supported in modern browsers and node.
```bash
# latest stable
yarn add @stoplight/path
```
### Usage
```ts
import * as path from '@stoplight/path';
// ...example
```
### 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 `master` branch.