Skip to content

Commit

Permalink
style: format everything
Browse files Browse the repository at this point in the history
  • Loading branch information
marcosvega91 committed Dec 4, 2020
1 parent c520f29 commit 6a3b4b2
Show file tree
Hide file tree
Showing 10 changed files with 52 additions and 59 deletions.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/---feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: "I have a suggestion (and might want to implement myself \U0001F642)!"
title: ''
labels: enhancement
assignees: ''

---

<!--
Expand Down
2 changes: 1 addition & 1 deletion .prettierrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ module.exports = {
singleQuote: true,
arrowParens: 'always',
proseWrap: 'always',
trailingComma: 'none',
trailingComma: 'none'
}
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CHANGELOG

The changelog is automatically updated using
[semantic-release](https://github.com/semantic-release/semantic-release). You
can see it on the [releases page](../../releases).
[semantic-release](https://github.com/semantic-release/semantic-release). You can see it on the
[releases page](../../releases).
8 changes: 4 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
the project team at [email protected]. All complaints will be reviewed and investigated and
will result in a response that is deemed necessary and appropriate to the circumstances. The project
team is obligated to maintain confidentiality with regard to the reporter of an incident. Further
details of specific enforcement policies may be posted separately.
the project team at [email protected]. All complaints will be reviewed and investigated and will
result in a response that is deemed necessary and appropriate to the circumstances. The project team
is obligated to maintain confidentiality with regard to the reporter of an incident. Further details
of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face
temporary or permanent repercussions as determined by other members of the project's leadership.
Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ Please make sure to run the tests before you commit your changes. You can do so

### Update Typings

The TypeScript type definitions can be found in the [DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react-hooks).
The TypeScript type definitions can be found in the
[DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react-hooks).

## Help needed

Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [react-hooks-testing-library](#react-hooks-testing-library)
- [The problem](#the-problem)
- [The solution](#the-solution)
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,9 +236,9 @@ function waitForValueToChange(selector: function(): any, options?: {
}): Promise<void>
```

Returns a `Promise` that resolves if the value returned from the provided selector changes. It is
expected that the [`result` of `renderHook`](/reference/api#result) will be used to select the
value for comparison.
Returns a `Promise` that resolves if the value returned from the provided selector changes. It is
expected that the [`result` of `renderHook`](/reference/api#result) will be used to select the value
for comparison.

#### `interval`

Expand Down
76 changes: 35 additions & 41 deletions other/MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,63 +17,57 @@ This is documentation for maintainers of this project.

## Code of Conduct

Please review, understand, and be an example of it. Violations of the code of
conduct are taken seriously, even (especially) for maintainers.
Please review, understand, and be an example of it. Violations of the code of conduct are taken
seriously, even (especially) for maintainers.

## Issues

We want to support and build the community. We do that best by helping people
learn to solve their own problems. We have an issue template and hopefully most
folks follow it. If it's not clear what the issue is, invite them to create a
minimal reproduction of what they're trying to accomplish or the bug they think
they've found.
We want to support and build the community. We do that best by helping people learn to solve their
own problems. We have an issue template and hopefully most folks follow it. If it's not clear what
the issue is, invite them to create a minimal reproduction of what they're trying to accomplish or
the bug they think they've found.

Once it's determined that a code change is necessary, point people to
[makeapullrequest.com](https://makeapullrequest.com) and invite them to make a
pull request. If they're the one who needs the feature, they're the one who can
build it. If they need some hand holding and you have time to lend a hand,
please do so. It's an investment into another human being, and an investment
into a potential maintainer.
[makeapullrequest.com](https://makeapullrequest.com) and invite them to make a pull request. If
they're the one who needs the feature, they're the one who can build it. If they need some hand
holding and you have time to lend a hand, please do so. It's an investment into another human being,
and an investment into a potential maintainer.

Remember that this is open source, so the code is not yours, it's ours. If
someone needs a change in the codebase, you don't have to make it happen
yourself. Commit as much time to the project as you want/need to. Nobody can ask
any more of you than that.
Remember that this is open source, so the code is not yours, it's ours. If someone needs a change in
the codebase, you don't have to make it happen yourself. Commit as much time to the project as you
want/need to. Nobody can ask any more of you than that.

## Pull Requests

As a maintainer, you're fine to make your branches on the main repo or on your
own fork. Either way is fine.
As a maintainer, you're fine to make your branches on the main repo or on your own fork. Either way
is fine.

When we receive a pull request, a GitHub Action is kicked off automatically (see
the `.github/workflows/validate.yml` for what runs in the Action). We avoid
merging anything that breaks the GitHub Action.
When we receive a pull request, a GitHub Action is kicked off automatically (see the
`.github/workflows/validate.yml` for what runs in the Action). We avoid merging anything that breaks
the GitHub Action.

Please review PRs and focus on the code rather than the individual. You never
know when this is someone's first ever PR and we want their experience to be as
positive as possible, so be uplifting and constructive.
Please review PRs and focus on the code rather than the individual. You never know when this is
someone's first ever PR and we want their experience to be as positive as possible, so be uplifting
and constructive.

When you merge the pull request, 99% of the time you should use the
[Squash and merge](https://help.github.com/articles/merging-a-pull-request/)
feature. This keeps our git history clean, but more importantly, this allows us
to make any necessary changes to the commit message so we release what we want
to release. See the next section on Releases for more about that.
[Squash and merge](https://help.github.com/articles/merging-a-pull-request/) feature. This keeps our
git history clean, but more importantly, this allows us to make any necessary changes to the commit
message so we release what we want to release. See the next section on Releases for more about that.

## Release

Our releases are automatic. They happen whenever code lands into `main`. A
GitHub Action gets kicked off and if it's successful, a tool called
[`semantic-release`](https://github.com/semantic-release/semantic-release) is
used to automatically publish a new release to npm as well as a changelog to
GitHub. It is only able to determine the version and whether a release is
necessary by the git commit messages. With this in mind, **please brush up on
[the commit message convention][commit] which drives our releases.**

> One important note about this: Please make sure that commit messages do NOT
> contain the words "BREAKING CHANGE" in them unless we want to push a major
> version. I've been burned by this more than once where someone will include
> "BREAKING CHANGE: None" and it will end up releasing a new major version. Not
> a huge deal honestly, but kind of annoying...
Our releases are automatic. They happen whenever code lands into `main`. A GitHub Action gets kicked
off and if it's successful, a tool called
[`semantic-release`](https://github.com/semantic-release/semantic-release) is used to automatically
publish a new release to npm as well as a changelog to GitHub. It is only able to determine the
version and whether a release is necessary by the git commit messages. With this in mind, **please
brush up on [the commit message convention][commit] which drives our releases.**

> One important note about this: Please make sure that commit messages do NOT contain the words
> "BREAKING CHANGE" in them unless we want to push a major version. I've been burned by this more
> than once where someone will include "BREAKING CHANGE: None" and it will end up releasing a new
> major version. Not a huge deal honestly, but kind of annoying...
## Thanks!

Expand Down
9 changes: 4 additions & 5 deletions other/manual-releases.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# manual-releases

This project has an automated release set up. So things are only released when
there are useful changes in the code that justify a release. But sometimes
things get messed up one way or another and we need to trigger the release
ourselves. When this happens, simply bump the number below and commit that with
the following commit message based on your needs:
This project has an automated release set up. So things are only released when there are useful
changes in the code that justify a release. But sometimes things get messed up one way or another
and we need to trigger the release ourselves. When this happens, simply bump the number below and
commit that with the following commit message based on your needs:

**Major**

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"prepare": "npm run build",
"build": "kcd-scripts build --out-dir lib",
"lint": "kcd-scripts lint",
"format": "kcd-scripts format",
"coverage": "codecov",
"test": "kcd-scripts test",
"docs:dev": "docz dev",
Expand Down

0 comments on commit 6a3b4b2

Please sign in to comment.