Skip to content

Commit c9a1876

Browse files
authored
Merge pull request #89 from Typeform/chore/REACH-468-eslint-prettier
chore(REACH-458): use typeform eslint and prettier config
2 parents 543362e + 4186093 commit c9a1876

39 files changed

+53216
-16643
lines changed

.eslintignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# output folder
2+
dist/

.eslintrc.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@typeform/eslint-config'],
3+
}

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,42 @@
11
---
22
name: Bug Report
33
about: Report a bug if something isn't working as expected
4-
54
---
65

76
<!-- Make sure to include as much information as possible so we can fix it as quickly as possible. -->
87
<!-- If you know how to fix this bug, please open a pull request on https://github.com/Typeform/js-api-client/compare/?template=bugs.md -->
98
<!-- If you can't answer some sections, please delete them -->
109

1110
## Description
11+
1212
<!-- Provide a description of this bug -->
1313

1414
## Expected Behavior
15+
1516
<!-- Tell us what should happen -->
1617

1718
## Current Behavior
19+
1820
<!-- Tell us what happens instead -->
1921

2022
## Possible Solution
23+
2124
<!-- Suggest a fix or reason for this bug -->
2225

2326
## Steps to Reproduce
27+
2428
<!-- Provide a link to a live example or steps to reproduce this bug -->
2529

2630
## Screenshots
31+
2732
<!-- Add screenshots of this bug -->
2833

2934
## Your Environment
35+
3036
<!-- Include as many relevant details about the environment you experienced the bug in -->
31-
* Client Version:
32-
* Node.js Version:
33-
* NPM Version:
34-
* Browser Name and Version:
35-
* Operating System and Version:
37+
38+
- Client Version:
39+
- Node.js Version:
40+
- NPM Version:
41+
- Browser Name and Version:
42+
- Operating System and Version:
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
---
22
name: Feature Request
33
about: Suggest an idea for this project
4-
54
---
65

76
<!-- Make sure to include as much information as possible so we can add it as quickly as possible. -->
87
<!-- If you know how to add this feature, please open a pull request on https://github.com/Typeform/js-api-client/compare/?template=features.md -->
98
<!-- If you can't answer some sections, please delete them -->
109

1110
## Description
11+
1212
<!-- Provide a description of this change or addition -->
1313

1414
## Context
15+
1516
<!-- Why is this change important to you? How would you use it? How can it benefit other users? -->
1617

1718
## Possible Solution
19+
1820
<!-- Suggest an idea for implementing this change or addition -->
1921

2022
## Screenshots
23+
2124
<!-- Add optional screenshots of this change or addition -->
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
name: Support Question
33
about: Ask a general support question about this project
4-
54
---

.github/PULL_REQUEST_TEMPLATE/bugs.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,23 @@
33
<!-- If you can't answer some sections, please delete them -->
44

55
## Description
6+
67
<!-- Describe your changes in detail -->
78

89
## Motivation and Context
10+
911
<!-- Why is this change required? What problem does it solve? -->
1012
<!-- If it fixes an open issue, please link to the issue here -->
1113

1214
## Testing
15+
1316
<!-- Please describe in detail how you tested your changes -->
1417
<!-- Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc.-->
1518

1619
## Backward Compatibility
20+
1721
<!-- Will your changes brake backward compatibility or not? -->
1822

1923
## Screenshots
24+
2025
<!-- Add screenshots of your changes -->

.github/PULL_REQUEST_TEMPLATE/features.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@
33
<!-- If you can't answer some sections, please delete them -->
44

55
## Description
6+
67
<!-- Describe your changes in detail -->
78

89
## Motivation and Context
10+
911
<!-- Why is this change required? How can it benefit other users? -->
1012
<!-- If it is from an open issue, please link to the issue here -->
1113

1214
## Testing
15+
1316
<!-- Please describe in detail how you tested your changes -->
1417
<!-- Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc
1518
1619
## Backward Compatibility
1720
<!-- Will your changes brake backward compatibility or not? -->
1821

1922
## Screenshots
23+
2024
<!-- Add screenshots of your changes -->

.github/workflows/ci-standard-checks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ jobs:
2121
- name: CI Standard Checks
2222
uses: Typeform/ci-standard-checks@v1
2323
with:
24-
githubToken: ${{ secrets.GITHUB_TOKEN }}
24+
githubToken: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
We'd love for you to contribute to our source code and to help make Typeform products even better than they are today! Here are the guidelines we'd like you to follow:
44

5-
* [Code of Conduct](#code-of-conduct)
6-
* [Issues and Bugs](#issues-and-bugs)
7-
* [Submission Guidelines](#submission-guidelines)
8-
* [Commit Message Guidelines](#commit-message-guidelines)
5+
- [Code of Conduct](#code-of-conduct)
6+
- [Issues and Bugs](#issues-and-bugs)
7+
- [Submission Guidelines](#submission-guidelines)
8+
- [Commit Message Guidelines](#commit-message-guidelines)
99

1010
## Code of Conduct
1111

@@ -33,37 +33,37 @@ Before you submit your issue, try searching [past issues][archive] or [StackOver
3333

3434
If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:
3535

36-
* **Description of the Issue** - if an error is being thrown a non-minified stack trace helps
37-
* **Motivation for or Use Case** - explain why this is a bug for you
38-
* **Related Issues** - has a similar issue been reported before?
39-
* **Environment Configuration** - is this a problem with Node.js, or only a specific browser? Is this only in a specific version of the library?
40-
* **Reproduce the Error** - provide a live example (like on [StackBlitz](https://stackblitz.com/)), a Github repo, or an unambiguous set of steps
41-
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
36+
- **Description of the Issue** - if an error is being thrown a non-minified stack trace helps
37+
- **Motivation for or Use Case** - explain why this is a bug for you
38+
- **Related Issues** - has a similar issue been reported before?
39+
- **Environment Configuration** - is this a problem with Node.js, or only a specific browser? Is this only in a specific version of the library?
40+
- **Reproduce the Error** - provide a live example (like on [StackBlitz](https://stackblitz.com/)), a Github repo, or an unambiguous set of steps
41+
- **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
4242

4343
### Submitting a Pull Request
4444

4545
#### Pull Request Guidelines
4646

47-
* Search [GitHub][pulls] for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
48-
* Create an issue to discuss a change before submitting a PR. We'd hate to have to turn down your contributions because of something that could have been communicated early on.
49-
* [Create a fork of the GitHub repo][fork-repo] to ensure that you can push your changes for us to review.
50-
* Make your changes in a new git branch:
47+
- Search [GitHub][pulls] for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
48+
- Create an issue to discuss a change before submitting a PR. We'd hate to have to turn down your contributions because of something that could have been communicated early on.
49+
- [Create a fork of the GitHub repo][fork-repo] to ensure that you can push your changes for us to review.
50+
- Make your changes in a new git branch:
5151

5252
```shell
5353
git checkout -b my-fix-branch dev
5454
```
5555

56-
* Create your patch, **including appropriate test cases**. Patches with tests are more likely to be merged.
57-
* Avoid checking in files that shouldn't be tracked (e.g `node_modules`, `gulp-cache`, `.tmp`, `.idea`). If your development setup automatically creates some of these files, please add them to the `.gitignore` at the root of the package (click [here][gitignore] to read more on how to add entries to the `.gitignore`).
58-
* Commit your changes using a commit message that follows our [commit message guidelines](#commit-message-guidelines).
56+
- Create your patch, **including appropriate test cases**. Patches with tests are more likely to be merged.
57+
- Avoid checking in files that shouldn't be tracked (e.g `node_modules`, `gulp-cache`, `.tmp`, `.idea`). If your development setup automatically creates some of these files, please add them to the `.gitignore` at the root of the package (click [here][gitignore] to read more on how to add entries to the `.gitignore`).
58+
- Commit your changes using a commit message that follows our [commit message guidelines](#commit-message-guidelines).
5959

6060
```shell
6161
git commit -a
6262
```
6363

6464
_Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files._
6565

66-
* Test your changes locally to ensure everything is in good working order:
66+
- Test your changes locally to ensure everything is in good working order:
6767

6868
```shell
6969
# Run the server in one terminal window
@@ -76,22 +76,22 @@ If your issue appears to be a bug, and hasn't been reported, open a new issue. P
7676
yarn test:integration
7777
```
7878

79-
* Push your branch to your fork on GitHub:
79+
- Push your branch to your fork on GitHub:
8080

8181
```shell
8282
git push origin my-fix-branch
8383
```
8484

85-
* In GitHub, send a pull request to `js-api-client:main`.
86-
* All pull requests must be reviewed by a member of the Typeform team, who will merge it when/if they feel it is good to go.
85+
- In GitHub, send a pull request to `js-api-client:main`.
86+
- All pull requests must be reviewed by a member of the Typeform team, who will merge it when/if they feel it is good to go.
8787

8888
## Commit Message Guidelines
8989

90-
We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use the git commit messages to **generate the project change log**.
90+
We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use the git commit messages to **generate the project change log**.
9191

9292
### Commit Message Format
9393

94-
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
94+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
9595

9696
```text
9797
<type>(<scope>): <subject>
@@ -111,15 +111,15 @@ If the commit reverts a previous commit, it should begin with `revert:`, followe
111111

112112
Must be one of the following:
113113

114-
* **feat**: A new feature
115-
* **fix**: A bug fix
116-
* **docs**: Documentation only changes
117-
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
118-
* **refactor**: A code change that neither fixes a bug nor adds a feature
119-
* **perf**: A code change that improves performance
120-
* **test**: Adding missing tests or correcting existing tests
121-
* **build**: Changes that affect the build system, CI configuration or external dependencies (example scopes: gulp, broccoli, npm)
122-
* **chore**: Other changes that don't modify `src` or `test` files
114+
- **feat**: A new feature
115+
- **fix**: A bug fix
116+
- **docs**: Documentation only changes
117+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
118+
- **refactor**: A code change that neither fixes a bug nor adds a feature
119+
- **perf**: A code change that improves performance
120+
- **test**: Adding missing tests or correcting existing tests
121+
- **build**: Changes that affect the build system, CI configuration or external dependencies (example scopes: gulp, broccoli, npm)
122+
- **chore**: Other changes that don't modify `src` or `test` files
123123

124124
That's it! Thank you for your contribution!
125125

0 commit comments

Comments
 (0)