Skip to content

Commit 15d406d

Browse files
committed
chore: update guide
1 parent 744e55a commit 15d406d

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,23 @@ cd craft.js
3030
4. Do your magic. :fireworks: Be sure that the package(s) that you're working on can still be successfully built after you've applied your changes.
3131
5. Submit a [pull request](https://github.com/prevwong/craft.js/compare) to merge the changes from your fork :heart: **(If your PR is not linked to an existing issue, then be sure to explain what your PR aims to accomplish)**
3232

33-
# URL
34-
- Production (master branch): https://craft.js.org/
35-
- Staging (develop branch): https://craftjs.netlify.com/
33+
## Pull requests
34+
35+
Craft.js uses [Changesets](https://github.com/changesets/changesets) to track and publish new releases.
36+
37+
Therefore, when you submit a change that affects functionality (ie: fix a bug or add a new feature) to one of the packages (in the `/packages/` folder), then you will need to create a new Changeset by running the following command:
38+
39+
```bash
40+
yarn changeset
41+
```
42+
43+
Typos and changes made to the `/examples` or the main `/site` do not require a changeset.
44+
45+
Currently Craft.js is still using major version 0.y.z, where y is only incremented when there's a major/breaking change. Hence, when creating a changeset:-
46+
- All backwards compatible changes and bug fixes should be labelled as a `patch`
47+
- Otherwise, it should be labelled as `minor`
48+
- `major` should **not** be used at the moment
49+
3650

3751
# License
3852
By contributing, you agree that your contributions will be licensed under MIT License.

0 commit comments

Comments
 (0)