Skip to content

Commit 1a5d027

Browse files
committed
Add "tests" back to documentation
1 parent f156594 commit 1a5d027

File tree

3 files changed

+20
-8
lines changed

3 files changed

+20
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ If you wish to contribute to the **Float Toolkit for React** source code, feel f
1111
1. Refer to the [documentation](https://float-toolkit.web.app) and [README file](https://github.com/float-toolkit/react/blob/master/README.md) to make sure the error is actually a bug and not a mistake of your own.
1212
1. Make sure the issue hasn't already been reported or suggested.
1313
1. Fork and clone the repository, and checkout the corresponding branch (`docs` for documentation, `master` for anything else). **DO NOT** modify the `stable` branch.
14-
1. Make your changes (add or modify documentation comments as necessary to cover your changes).
15-
1. Run `npm run build` (or VSCode task _NPM: Build_) to build the package (you can use `npm link` to try it locally).
14+
1. Make your changes (add or modify tests and documentation comments as necessary to cover your changes).
15+
1. Run `npm run build` (or VSCode task _NPM: Build_) to run the tests and build the package (you can use `npm link` to try it locally).
1616
1. [Submit a pull request](https://github.com/float-toolkit/react/compare).

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@
44

55
<h1 align="center">New Pull Request</h1>
66

7-
## Before you go ANY further...
7+
## First things first...
88

9-
- Make sure to read the [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md).
9+
- Make sure to read the [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md) before you go any further.
1010
- Is there an issue related to your changes? If so, link to it here. If not, create an issue before submitting your pull request in order to discuss.
11-
- Add or modify documentation comments as needed in order to make your code understandable.
11+
12+
## (How) do your changes work?
13+
14+
- Run all existing tests in the repository and make sure all of them pass.
15+
- Add or modify tests as needed to cover your changes.
16+
- Finally, add or modify documentation comments as needed.
1217

1318
Thank you for contributing to the **Float Toolkit** codebase!

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
[![NPM latest version](https://img.shields.io/npm/v/@float-toolkit/react?label=version&logo=npm)](https://www.npmjs.com/package/@float-toolkit/react)
1010
[![NPM downloads](https://img.shields.io/npm/dt/@float-toolkit/react?logo=npm)](https://www.npmjs.com/package/@float-toolkit/react)
11+
[![Tests status](https://img.shields.io/github/workflow/status/float-toolkit/react/Test%20with%20Vitest?label=tests&logo=vite&logoColor=white)](https://github.com/float-toolkit/react/actions/workflows/testWithVitest.yml)
12+
[![Code coverage with Codecov](https://img.shields.io/codecov/c/github/float-toolkit/react/tests?logo=codecov&logoColor=white)](https://codecov.io/gh/float-toolkit/react)
13+
[![Contributor Covenant Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-5e0d73)](https://github.com/float-toolkit/react/blob/master/.github/CODE_OF_CONDUCT.md)
1114

1215
</div>
1316

@@ -72,17 +75,21 @@ const Sum: FC<Props> = (props) => {
7275
};
7376
```
7477

78+
## Support
79+
80+
Need help using Float Toolkit? Don't hesitate to reach out on [GitHub Discussions](https://github.com/float-toolkit/react/discussions/categories/q-a)!
81+
7582
## Links
7683

77-
- [FloatToolkit documentation (Vanilla JS)](https://float-toolkit.web.app/)
84+
- [FloatToolkit documentation (Vanilla JS)](https://float-toolkit.web.app)
7885
- [GitHub](https://github.com/float-toolkit/react)
79-
- [npm](https://www.npmjs.com/package/@float-toolkit/react)
86+
- [npm](https://npmjs.com/package/@float-toolkit/react)
8087

8188
## Contributing
8289

8390
Before creating an issue, please consider the following:
8491

85-
- Refer to the [FloatToolkit documentation](https://float-toolkit.web.app/) and read **this file** carefully to make sure the error is actually a bug and not a mistake of your own.
92+
- Read the [documentation](https://float-toolkit.web.app) and **this file** carefully to make sure the error is actually a bug and not a mistake of your own.
8693
- Make sure the issue hasn't already been reported or suggested.
8794
- After following these steps, you can file an issue using one of our [templates](https://github.com/float-toolkit/react/issues/new/choose). Please make sure to follow our [Code of Conduct](https://github.com/float-toolkit/react/blob/master/.github/CODE_OF_CONDUCT.md).
8895
- If you wish to [submit a pull request](https://github.com/float-toolkit/react/compare) alongside your issue, please follow our [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md).

0 commit comments

Comments
 (0)