Skip to content

Commit ff25ffd

Browse files
docs: add releases section
1 parent 805495c commit ff25ffd

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,18 @@ npm install
282282
npm run build:dev
283283
```
284284

285+
## Commits conventions and releases
286+
287+
We do use [Semantic Release](https://github.com/semantic-release/semantic-release) for automated releases and repo housekeeping. To allow Semantic Release do its job we follow some light commit message conventions:
288+
- use `fix:` prefix if commit fixes an issue (**triggers a PATCH release** `0.5.0` => `0.5.1`)
289+
- use `feat:` prefix if commit is part of a new feature (**triggers a MINOR release** `0.5.0` => `0.6.0`)
290+
- use `docs:` prefix if commit is updating a documentation (like README)
291+
- use `chore:` or no prefix for general purpose changes
292+
- use `BREAKING CHANGE:` in the commit footer if you need to release a new MAJOR version (`0.5.0` => `1.0.0`)
293+
294+
Examples: `fix: correct floating numbers bug`, `docs: fixed typo`
295+
296+
285297
## Support
286298

287299
For any issues, contact [Bright Data support](https://brightdata.com/contact), or open an issue in this repository.

0 commit comments

Comments
 (0)