Skip to content

Commit 3de49ba

Browse files
committed
chore: add contribution guidelines to readme
1 parent 8d24ecd commit 3de49ba

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Release
22

33
on:
44
push:
5-
branches: [develop]
5+
branches: [master]
66

77
jobs:
88
build:

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,37 @@ Seek to a given frame. Frame value can be a number or a percent string (e.g. 50%
255255

256256
Type: `void`
257257

258+
## Contributing
259+
260+
We use changesets to maintain a changelog for this repository. When making any change to the codebase that impacts functionality or performance we require a changeset to be present.
261+
262+
To add a changeset run:
263+
264+
```
265+
yarn run changeset
266+
```
267+
268+
And select the type of version bump you'd like (major, minor, path).
269+
270+
You can document the change in detail and format it properly using Markdown by opening the ".md" file that the "yarn changeset" command created in the ".changeset" folder. Open the file, it should look something like this:
271+
272+
```
273+
---
274+
"@lottiefiles/pkg1": minor
275+
"@lottiefiles/pkg2": major
276+
---
277+
278+
This is where you document your **changes** using Markdown.
279+
280+
- You can write
281+
- However you'd like
282+
- In as much detail as you'd like
283+
284+
Aim to provide enough details so that team mates and future you can understand the changes and the context of the change.
285+
```
286+
287+
You can commit your changes and the changeset to your branch and then create a pull request on the develop branch.
288+
258289
## License
259290

260291
MIT License © LottieFiles.com

0 commit comments

Comments
 (0)