Skip to content

Commit c1d1b1c

Browse files
committed
chore(TypeScript): fixes to previous commit
1 parent bacf08d commit c1d1b1c

File tree

11 files changed

+77
-59
lines changed

11 files changed

+77
-59
lines changed

.github/CONTRIBUTING.md

Lines changed: 66 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,40 @@ Thanks for taking the time to contribute!
99
[Contribution prerequisites](#contribution-prerequisites)
1010

1111
[Project Setup](#project-setup)
12-
* [How to run the project](#how-to-run-the-project)
13-
* [How to run tests](#how-to-run-tests)
12+
13+
- [How to run the project](#how-to-run-the-project)
14+
- [How to run tests](#how-to-run-tests)
1415

1516
[How can you contribute](#how-can-you-contribute)
16-
* [Reporting bugs](#reporting-bugs)
17-
* [Suggesting enhancements](#suggesting-enhancements)
18-
* [Writing documentation](#writing-documentation)
19-
* [Your first code contribution](#your-first-code-contribution)
17+
18+
- [Reporting bugs](#reporting-bugs)
19+
- [Suggesting enhancements](#suggesting-enhancements)
20+
- [Writing documentation](#writing-documentation)
21+
- [Your first code contribution](#your-first-code-contribution)
2022

2123
[Additional Notes](#additional-notes)
22-
* [Issue and Pull Request Templates](#issue-and-pull-request-templates)
23-
* [Need help?](#need-help?)
24+
25+
- [Issue and Pull Request Templates](#issue-and-pull-request-templates)
26+
- [Need help?](#need-help?)
2427

2528
## Code of Conduct
2629

27-
This project and everyone contributing to it adheres to the [ResearchGate Code of Conduct](CODE_OF_CONDUCT.md).
28-
By participating you are expected to uphold this code. Please report any behavior you find unacceptable to [[email protected]](mailto:[email protected]).
30+
This project and everyone contributing to it adheres to the
31+
[ResearchGate Code of Conduct](CODE_OF_CONDUCT.md). By participating you are
32+
expected to uphold this code. Please report any behavior you find unacceptable
33+
2934

3035
## Contribution prerequisites
3136

3237
Before you start your work, make sure that you:
3338

34-
* have `node` installed at v6.10.0
35-
* have `npm` installed at 5.3.0
36-
* have `yarn` installed at v0.21.3
37-
* are familiar with `git`
38-
* are familiar with [conventional commits](http://conventionalcommits.org)
39-
* have read and agree to abide by the [ResearchGate Code of Conduct](CODE_OF_CONDUCT.md)
39+
- have `node` installed at v6.10.0
40+
- have `npm` installed at 5.3.0
41+
- have `yarn` installed at v0.21.3
42+
- are familiar with `git`
43+
- are familiar with [conventional commits](http://conventionalcommits.org)
44+
- have read and agree to abide by the
45+
[ResearchGate Code of Conduct](CODE_OF_CONDUCT.md)
4046

4147
## Project setup
4248

@@ -63,20 +69,15 @@ npm run storybook
6369

6470
### How to run tests
6571

66-
This project uses [jest](http://facebook.github.io/jest/) for JavaScript testing.
72+
This project uses [jest](http://facebook.github.io/jest/) for JavaScript
73+
testing.
6774

6875
To run tests, execute:
6976

7077
```
7178
yarn test
7279
```
7380

74-
Since coverage is not collected by default when running yarn test, run:
75-
76-
```
77-
yarn coverage
78-
```
79-
8081
To run linters use:
8182

8283
```
@@ -87,49 +88,70 @@ yarn lint
8788

8889
### Reporting bugs
8990

90-
This section guides you through the steps to follow when you submit a bug report for a ResearchGate project.
91+
This section guides you through the steps to follow when you submit a bug report
92+
for a ResearchGate project.
9193

92-
Following these guidelines makes it easy for the maintainers and community to understand your report, reproduce the behavior, and find related reports.
94+
Following these guidelines makes it easy for the maintainers and community to
95+
understand your report, reproduce the behavior, and find related reports.
9396

94-
Before creating a bug report, please check Open Issues as you may find that there is already an issue open for the bug you’ve found. When you create a bug report, be sure to include as much detail as possible and fill out [the required template](ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
97+
Before creating a bug report, please check Open Issues as you may find that
98+
there is already an issue open for the bug you’ve found. When you create a bug
99+
report, be sure to include as much detail as possible and fill out
100+
[the required template](ISSUE_TEMPLATE.md), the information it asks for helps us
101+
resolve issues faster.
95102

96-
After you have submitted the issue, we'll try to get back to you as soon as possible.
103+
After you have submitted the issue, we'll try to get back to you as soon as
104+
possible.
97105

98106
### Suggesting enhancements
99107

100108
This section guides you through submitting a feature suggestion.
101109

102-
All enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/) and, when approved by a core team member or project maintainer, are given the green light to then be turned into a Pull Request.
103-
For the best possible experience, please provide us with:
110+
All enhancement suggestions are tracked as
111+
[GitHub issues](https://guides.github.com/features/issues/) and, when approved
112+
by a core team member or project maintainer, are given the green light to then
113+
be turned into a Pull Request. For the best possible experience, please provide
114+
us with:
104115

105-
* **A clear and descriptive title**
106-
* **A step-by-step description of the suggested enhancement** and what it should do
107-
* **Specific examples to demonstrate the steps**. Ideally, you should support it with code snippets, screenshots, and/or animated GIFs
108-
* **Explanation of why this feature would be useful** to this project
109-
* **Your development environment** and context for creating the feature
116+
- **A clear and descriptive title**
117+
- **A step-by-step description of the suggested enhancement** and what it should
118+
do
119+
- **Specific examples to demonstrate the steps**. Ideally, you should support it
120+
with code snippets, screenshots, and/or animated GIFs
121+
- **Explanation of why this feature would be useful** to this project
122+
- **Your development environment** and context for creating the feature
110123

111-
After you have submitted your Pull Request, we'll try to get back to you as soon as possible.
124+
After you have submitted your Pull Request, we'll try to get back to you as soon
125+
as possible.
112126

113127
### Writing documentation
114128

115-
All great projects require good documentation.
116-
There is __always__ room for (better) docs, so why not to contribute to the project by enhancing them?
117-
Please do so via Pull Request.
129+
All great projects require good documentation. There is **always** room for
130+
(better) docs, so why not to contribute to the project by enhancing them? Please
131+
do so via Pull Request.
118132

119133
### Your first code contribution
120134

121-
Unsure where you can start contributing?
122-
We strive to make all our projects easy for beginners to contribute to. Just look out for issues labeled `help-wanted` and `beginner-friendly`, then get stuck in!
123-
If you still need some guidance, consider [this resource](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) and/or contact us.
135+
Unsure where you can start contributing? We strive to make all our projects easy
136+
for beginners to contribute to. Just look out for issues labeled `help-wanted`
137+
and `beginner-friendly`, then get stuck in! If you still need some guidance,
138+
consider
139+
[this resource](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
140+
and/or contact us.
124141

125142
## Additional notes
126143

127144
### Issue and pull request templates
128145

129-
When filing an issue or pull request, please take the time to fill out the templates we provide in as much detail as you can. This helps ensure that we have all the information we need to provide you with the right support so that your experience contributing to our open-source project runs as smoothly and easily as you would like it to.
146+
When filing an issue or pull request, please take the time to fill out the
147+
templates we provide in as much detail as you can. This helps ensure that we
148+
have all the information we need to provide you with the right support so that
149+
your experience contributing to our open-source project runs as smoothly and
150+
easily as you would like it to.
130151

131152
### Need help?
132153

133-
If you need any help or require additional information, don't hesitate to contact the project maintainer or any of the contributors.
154+
If you need any help or require additional information, don't hesitate to
155+
contact the project maintainer or any of the contributors.
134156

135-
Thank you for contributing!
157+
Thank you for contributing!

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ yarn-error.log
77
.DS_Store
88
/.vscode
99
tsconfig.tsbuildinfo
10-
typings
10+
typings
11+
test/coverage

docs/docs/components/HigherOrderComponent/WithIntersectionObserver.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React, { Component } from 'react';
2-
import Observer from '@researchgate/react-intersection-observer';
2+
import Observer from '../../../..';
33

44
export default (threshold) => (BaseComponent) => {
55
const displayName =

docs/docs/components/ImpressionTracking/AdImpression.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react';
22
import PropTypes from 'prop-types';
33
import { action } from '@storybook/addon-actions';
4-
import Observer from '@researchgate/react-intersection-observer';
4+
import Observer from '../../../..';
55

66
const tracked = action('tracked');
77

docs/docs/components/OnlyOnce/OnlyOnce.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { Component } from 'react';
22
import { decorateAction } from '@storybook/addon-actions';
3-
import Observer from '@researchgate/react-intersection-observer';
3+
import Observer from '../../../..';
44

55
const storyBookAction = decorateAction([
66
(args) =>

docs/docs/components/Playground/PlaygroundRootMargin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React, { Component } from 'react';
22
import { decorateAction } from '@storybook/addon-actions';
33
import { select } from '@storybook/addon-knobs/react';
4-
import Observer from '@researchgate/react-intersection-observer';
4+
import Observer from '../../../..';
55

66
const storyBookAction = decorateAction([
77
(args) =>

docs/docs/components/WindowFrame/WindowFrame.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { Component } from 'react';
22
import { decorateAction } from '@storybook/addon-actions';
3-
import Observer from '@researchgate/react-intersection-observer';
3+
import Observer from '../../../..';
44

55
const storyBookAction = decorateAction([
66
(args) =>

docs/docs/components/WindowRoot/WindowRoot.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { Component } from 'react';
22
import { decorateAction } from '@storybook/addon-actions';
3-
import Observer from '@researchgate/react-intersection-observer';
3+
import Observer from '../../../..';
44

55
const storyBookAction = decorateAction([
66
(args) =>

docs/docs/components/WithRootMargin/WithRootMargin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { Component } from 'react';
22
import { decorateAction } from '@storybook/addon-actions';
3-
import Observer from '@researchgate/react-intersection-observer';
3+
import Observer from '../../../..';
44

55
const storyBookAction = decorateAction([
66
(args) =>

docs/docs/components/WithThresholds/WithThresholds.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { Component } from 'react';
22
import { decorateAction } from '@storybook/addon-actions';
3-
import Observer from '@researchgate/react-intersection-observer';
3+
import Observer from '../../../..';
44

55
const storyBookAction = decorateAction([
66
(args) =>

0 commit comments

Comments
 (0)