You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -184,6 +184,37 @@ set background color.
184
184
#### Returns
185
185
186
186
Type: `void`
187
+
188
+
## Contributing
189
+
190
+
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.
191
+
192
+
To add a changeset run:
193
+
194
+
```
195
+
yarn run changeset
196
+
```
197
+
198
+
And select the type of version bump you'd like (major, minor, path).
199
+
200
+
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:
201
+
202
+
```
203
+
---
204
+
"@lottiefiles/pkg1": minor
205
+
"@lottiefiles/pkg2": major
206
+
---
207
+
208
+
This is where you document your **changes** using Markdown.
209
+
210
+
- You can write
211
+
- However you'd like
212
+
- In as much detail as you'd like
213
+
214
+
Aim to provide enough details so that team mates and future you can understand the changes and the context of the change.
215
+
```
216
+
217
+
You can commit your changes and the changeset to your branch and then create a pull request on the develop branch.
0 commit comments