Skip to content
This repository was archived by the owner on Jul 3, 2024. It is now read-only.

Commit 22a52ab

Browse files
author
Cesar Perez
authored
docs: update README and trigger Major version bump to account for previous commits (#36)
BREAKING CHANGE: previous commits refactored to ESM module
1 parent bc0e4ef commit 22a52ab

File tree

1 file changed

+1
-10
lines changed

1 file changed

+1
-10
lines changed

README.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,6 @@ $ npm install @formidable/dogs
1414
$ yarn add @formidable/dogs
1515
```
1616

17-
## Use
18-
19-
```
20-
import dogs from '@formidable/dogs';
21-
22-
// You can also import the Dog type if needed
23-
import dogs, { Dog } from '@formidable/dogs';
24-
```
25-
2617
## Contributing
2718

2819
This repository is configured using [semantic-release](https://github.com/semantic-release/semantic-release) which automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.
@@ -31,7 +22,7 @@ What does this mean for contributors? It means we need a merge commit that follo
3122

3223
1. Our target for `semantic-release` is a "Squash and merge" GitHub pull request merge. Our repository _only_ allows this kind of merge. We aim to have the _final_ commit meet the conventional commit format.
3324
* **Note**: This means that along the way to that final merge commit, it doesn't matter how you commit. We don't do pre-commit hooks, nor lint individual commits in a pull request. All we check is the final merge commit to make sure it's all good.
34-
2. This means that the thing you need to check is the **pull request title** which is what will be used in the squash and merge commit to trigger `semantic release`. We use [semantic-pull-requests](https://github.com/zeke/semantic-pull-requests) to make sure that our PRs have a title meet the eventual format needed. And no worries about changes along the way! You just need to get the PR title in appropriate shape by the time you want to merge.
25+
2. This means that the thing you need to check is the **pull request title** which is what will be used in the squash and merge commit to trigger `semantic release`. We use [semantic-pull-requests](https://github.com/zeke/semantic-pull-requests)(**NO LONGER MAINTAINED**) to make sure that our PRs have a title meet the eventual format needed. And no worries about changes along the way! You just need to get the PR title in appropriate shape by the time you want to merge.
3526

3627
There are very precise rules over how git commit messages can be formatted. This leads to **more
3728
readable messages** that are easy to follow when looking through the **project history**. Also,

0 commit comments

Comments
 (0)