Skip to content

Commit e4e3387

Browse files
tweaks
1 parent ba167ed commit e4e3387

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Thanks for taking the time to contribute! :smile:
2222
- [Adding Pages](#adding-pages)
2323
- [A Worked Example](#a-worked-example)
2424
- [Deleting Pages](#deleting-pages)
25-
- [Committing Code](#committing-code)
26-
- [Pull Requests](#pull-requests)
2725
- [Writing the Changelog](#writing-the-changelog)
2826
- [Categories](#categories)
27+
- [Committing Code](#committing-code)
28+
- [Pull Requests](#pull-requests)
2929
- [Contributor License Agreement](#contributor-license-agreement)
3030
- [Deployment](#deployment)
3131
- [Trigger workflow build](#trigger-workflow-build)
@@ -374,6 +374,30 @@ To delete a page:
374374
- Build the documentation site locally so that you can visually inspect and make
375375
sure it was properly deleted.
376376

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+
377401
## Committing Code
378402

379403
### Pull Requests
@@ -411,30 +435,6 @@ open a pull request (PR) from your repo to the
411435
git branch name. For example, if my branch was named `my-branch`, my branch
412436
preview will be available at `https://my-branch--cypress-docs.netlify.app`.
413437

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-
438438
### Contributor License Agreement
439439

440440
We use a [`cla-assistant.io`](https://cla-assistant.io/) web hook to make sure

readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,15 @@ Javascript code is linted with [ESLint](https://eslint.org/).
5858

5959
CSS code is linted with [stylelint](https://stylelint.io/).
6060

61+
Markdown is formatted with [Prettier](https://prettier.io/).
62+
6163
```sh
6264
yarn lint
6365
```
6466

6567
#### Unit Tests
6668

67-
Javascirpt code is unit tested with [Jest](https://jestjs.io/).
69+
Javascript code is unit tested with [Jest](https://jestjs.io/).
6870

6971
```sh
7072
yarn test:unit
@@ -74,7 +76,7 @@ yarn test:unit
7476

7577
We use Cypress itself to test the documentation.
7678

77-
Start the server and run the tests:
79+
Run the tests:
7880

7981
```sh
8082
yarn test

0 commit comments

Comments
 (0)