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
We welcome [issues](https://github.com/Microsoft/VoTT/issues) and [pull requests](https://github.com/Microsoft/VoTT/pulls) into the project. We ask that you follow these simple guidelines:
- Look for duplicate issues & comment on thread if experiencing something similar
23
-
- Fill in template information (platform, OS, version, screenshots, etc.)
26
+
* Look for duplicate issues & comment on thread if experiencing something similar
27
+
* Fill in template information (platform, OS, version, screenshots, etc.)
24
28
25
29
## Pull Requests
26
30
27
-
1. Find an issue to work on, or create a new one
28
-
2. Fork repo, make sure you have latest changes from `v2`
29
-
3. Create branch following naming convention: `git checkout -b issue-<###>-<short-description>`.
30
-
4. Write code
31
-
5. Add unit tests
32
-
6. Verify linting and unit tests by running `npm test`
33
-
7. Update docs if needed
34
-
8. Rebase on `v2` and resolve conflicts
35
-
9. Commit your changes using a descriptive commit message that follows [our commit message conventions](#commit-message-guidelines). Adherence to these conventions is necessary because the [change log](CHANGELOG.md)is automatically generated from these messages.
36
-
10. Submit PR to `v2` branch
31
+
1. Find an issue to work on, or create a new one.
32
+
1. Fork the repo and/or pull down the latest changes from `master`.
33
+
1. Create branch following naming convention: `git checkout -b issue-<###>-<short-description>`.
34
+
1. Write code.
35
+
1. Add unit tests.
36
+
1. Verify linting and unit tests by running `npm test`.
37
+
1. Update docs if needed.
38
+
1. Rebase on `master` and resolve conflicts.
39
+
1. Commit your changes using a descriptive commit message that follows [our commit message conventions](#commit-message-guidelines). Adherence to these conventions is necessary for the [change log](CHANGELOG.md)to be automatically generated from these messages.
40
+
1. Submit PR to `master` branch.
37
41
38
-
Try to keep PRs small to decrease the time required to review and merge.
42
+
Please try to keep PRs small to decrease the time required to review and merge.
39
43
40
44
## Commit Message Guidelines
41
-
We have adopted standards similar to [Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) for how our git commit messages should be formatted. We believe that this leads to more readable messages that are easier to follow when looking through the project history and in addition, are used to generate the [VoTT change log](CHANGELOG.md).
42
45
46
+
We have adopted standards similar to [Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) for how our git commit messages should be formatted. This leads to more readable messages, which are easier to follow when looking through the project history. Those messages are used to generate the [VoTT change log](CHANGELOG.md).
43
47
44
48
### Commit Message Format
49
+
45
50
Each commit message consists of a **header**, a **body** and a **footer**.
46
51
47
-
```
52
+
```text
48
53
<type>: <short description>
49
54
<BLANK LINE>
50
55
<body>
@@ -53,7 +58,9 @@ Each commit message consists of a **header**, a **body** and a **footer**.
53
58
```
54
59
55
60
### Header
61
+
56
62
#### Type
63
+
57
64
Must be one of the following:
58
65
59
66
***build**: Changes that affect the build system or external dependencies
@@ -67,32 +74,38 @@ Must be one of the following:
67
74
***test**: Adding missing tests or correcting existing tests
68
75
69
76
#### Short Description
77
+
70
78
Contains a succinct description of the change:
71
79
72
80
* use the imperative, present tense: "change" not "changed" nor "changes"
73
81
* don't capitalize the first letter
74
82
* no dot (.) at the end
75
83
76
84
### Body
85
+
77
86
Just as in the **short description**, use the imperative, present tense: "change" not "changed" nor "changes".
78
87
The body should include the motivation for the change and contrast this with previous behavior.
79
88
80
89
### Footer
81
-
The footer should contain any information about **Breaking Changes** and is also the place to
82
-
reference Azure DevOps user stories/tasks or GitHub issues that this commit **Closes**.
90
+
91
+
The footer should contain any information about **breaking changes** and is also the place to
92
+
reference Azure DevOps user stories/tasks or GitHub issues that this commit **closes**.
83
93
84
94
### Commit Message Example
85
-
```
95
+
96
+
```text
86
97
fix: add debouncing to asset scroller to correct browser scroll position
87
98
88
99
There is no debouncing when we store the asset container's scroll position.
89
-
This results in erratic, jumpy scrolling and a poor user experience. improve
100
+
This results in erratic, jumpy scrolling and a poor user experience. Improve
90
101
stability and usability with debouncing.
91
102
92
103
AB#17056
93
104
```
94
105
95
106
## Style
96
107
97
-
1. This repo uses [EditorConfig](https://editorconfig.org/) to maintain consistent styles across multiple platforms and IDEs., please refer to
108
+
* This repo uses [EditorConfig](https://editorconfig.org/) to maintain consistent styles across multiple platforms and IDEs. Please refer to
0 commit comments