@@ -22,10 +22,10 @@ Thanks for taking the time to contribute! :smile:
22
22
- [ Adding Pages] ( #adding-pages )
23
23
- [ A Worked Example] ( #a-worked-example )
24
24
- [ Deleting Pages] ( #deleting-pages )
25
- - [ Committing Code] ( #committing-code )
26
- - [ Pull Requests] ( #pull-requests )
27
25
- [ Writing the Changelog] ( #writing-the-changelog )
28
26
- [ Categories] ( #categories )
27
+ - [ Committing Code] ( #committing-code )
28
+ - [ Pull Requests] ( #pull-requests )
29
29
- [ Contributor License Agreement] ( #contributor-license-agreement )
30
30
- [ Deployment] ( #deployment )
31
31
- [ Trigger workflow build] ( #trigger-workflow-build )
@@ -374,6 +374,30 @@ To delete a page:
374
374
- Build the documentation site locally so that you can visually inspect and make
375
375
sure it was properly deleted.
376
376
377
+ ### Writing the Changelog
378
+
379
+ When adding to the Changelog, create a new file in
380
+ [ ` content/_changelogs ` ] ( /content/_changelogs ) named as the version number. Be
381
+ sure to follow the category structure defined below (in this order). Each bullet
382
+ point in the list should _ always_ be associated to an issue on the
383
+ [ ` cypress ` ] ( https://github.com/cypress-io/cypress ) repo and link to that issue
384
+ (except for Documentation changes).
385
+
386
+ #### Categories
387
+
388
+ - ** Summary** - If it is a large release, you may write a summary explaining
389
+ what the point of this release is (mostly used for breaking releases)
390
+ - ** Breaking Changes** - The users current implementation of Cypress may break
391
+ after updating.
392
+ - ** Deprecations** - Features have been deprecated, but will not break after
393
+ updating.
394
+ - ** Features** - A new feature
395
+ - ** Bugfixes** - A bug existed in Cypress and a PR fixed the issue
396
+ - ** Misc** - Not a feature or bugfix, but work that was done. May be internal
397
+ work that was done and associated with an issue
398
+ - ** Documentation Changes** - our docs were updated based on behavior changes in
399
+ release
400
+
377
401
## Committing Code
378
402
379
403
### Pull Requests
@@ -411,30 +435,6 @@ open a pull request (PR) from your repo to the
411
435
git branch name. For example, if my branch was named ` my-branch ` , my branch
412
436
preview will be available at ` https://my-branch--cypress-docs.netlify.app ` .
413
437
414
- ### Writing the Changelog
415
-
416
- When adding to the Changelog, create a new file in
417
- [ ` content/_changelogs ` ] ( /content/_changelogs ) named as the version number. Be
418
- sure to follow the category structure defined below (in this order). Each bullet
419
- point in the list should _ always_ be associated to an issue on the
420
- [ ` cypress ` ] ( https://github.com/cypress-io/cypress ) repo and link to that issue
421
- (except for Documentation changes).
422
-
423
- #### Categories
424
-
425
- - ** Summary** - If it is a large release, you may write a summary explaining
426
- what the point of this release is (mostly used for breaking releases)
427
- - ** Breaking Changes** - The users current implementation of Cypress may break
428
- after updating.
429
- - ** Deprecations** - Features have been deprecated, but will not break after
430
- updating.
431
- - ** Features** - A new feature
432
- - ** Bugfixes** - A bug existed in Cypress and a PR fixed the issue
433
- - ** Misc** - Not a feature or bugfix, but work that was done. May be internal
434
- work that was done and associated with an issue
435
- - ** Documentation Changes** - our docs were updated based on behavior changes in
436
- release
437
-
438
438
### Contributor License Agreement
439
439
440
440
We use a [ ` cla-assistant.io ` ] ( https://cla-assistant.io/ ) web hook to make sure
0 commit comments