@haskou/value-objects 2.6.0 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
[](https://github.com/haskou/value-objects/actions/workflows/ci.yml?query=branch%3Amaster)
|
|
2
|
+
[](https://codecov.io/gh/haskou/value-objects)
|
|
3
|
+
[](https://www.npmjs.com/package/@haskou/value-objects)
|
|
4
|
+
[](LICENSE.txt)
|
|
2
5
|
|
|
3
6
|
# Value Objects
|
|
4
7
|
|
|
@@ -195,10 +198,23 @@ npm test
|
|
|
195
198
|
npm run build
|
|
196
199
|
```
|
|
197
200
|
|
|
201
|
+
## 🌿 Release Branches
|
|
202
|
+
|
|
203
|
+
Publishing is handled by CI when a pull request is merged into the default
|
|
204
|
+
branch (`master`, or `main` after a branch rename). Use these branch prefixes
|
|
205
|
+
to choose the npm version bump:
|
|
206
|
+
|
|
207
|
+
- `fix/*` - patch release
|
|
208
|
+
- `feat/*` - minor release
|
|
209
|
+
- `break/*` - major release
|
|
210
|
+
|
|
211
|
+
Branches without one of these prefixes still run CI, but they do not publish
|
|
212
|
+
to npm. Publishing uses npm Trusted Publishing from the `ci.yml` workflow.
|
|
213
|
+
|
|
198
214
|
## 🤝 Contributing
|
|
199
215
|
|
|
200
216
|
1. Fork the repository
|
|
201
|
-
2. Create a branch: `git checkout -b my-feature`
|
|
217
|
+
2. Create a branch: `git checkout -b feat/my-feature`
|
|
202
218
|
3. Make your changes and add tests
|
|
203
219
|
4. Run tests: `npm test`
|
|
204
220
|
5. Submit a pull request
|