You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+32-32Lines changed: 32 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,10 @@
2
2
3
3
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:
@@ -33,37 +33,37 @@ Before you submit your issue, try searching [past issues][archive] or [StackOver
33
33
34
34
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:
35
35
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)
42
42
43
43
### Submitting a Pull Request
44
44
45
45
#### Pull Request Guidelines
46
46
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:
51
51
52
52
```shell
53
53
git checkout -b my-fix-branch dev
54
54
```
55
55
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).
59
59
60
60
```shell
61
61
git commit -a
62
62
```
63
63
64
64
_Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files._
65
65
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:
67
67
68
68
```shell
69
69
# 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
76
76
yarn test:integration
77
77
```
78
78
79
-
* Push your branch to your fork on GitHub:
79
+
- Push your branch to your fork on GitHub:
80
80
81
81
```shell
82
82
git push origin my-fix-branch
83
83
```
84
84
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.
87
87
88
88
## Commit Message Guidelines
89
89
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**.
91
91
92
92
### Commit Message Format
93
93
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**:
95
95
96
96
```text
97
97
<type>(<scope>): <subject>
@@ -111,15 +111,15 @@ If the commit reverts a previous commit, it should begin with `revert:`, followe
111
111
112
112
Must be one of the following:
113
113
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
0 commit comments