Skip to content

Commit 33e0f7f

Browse files
mydiemhowbreza
authored andcommitted
doc: updating readme (microsoft#733)
* update Readme.md and Contributing.md * remove markdown-toc * new screenshots ( jpg ) * add mouse and keyboard shortcuts from vott-ct #AB17930
1 parent b89d7eb commit 33e0f7f

16 files changed

+172
-107
lines changed

CONTRIBUTING.md

+44-31
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,55 @@
11
# Contributing to VoTT
2+
23
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:
34

5+
<!-- generated using: https://www.npmjs.com/package/markdown-toc-->
6+
<!-- command: `markdown-toc -i CONTRIBUTING.md --bullets "*"`-->
7+
48
<!-- toc -->
59

6-
- [Issues](#issues)
7-
- [Pull Requests](#pull-requests)
8-
- [Commit Message Guidelines](#commit-message-guidelines)
9-
- [Commit Message Format](#commit-message-format)
10-
- [Header](#header)
11-
- [Type](#type)
12-
- [Short Description](#short-description)
13-
- [Body](#body)
14-
- [Footer](#footer)
15-
- [Commit Message Example](#commit-message-example)
16-
- [Style](#style)
10+
* [Issues](#issues)
11+
* [Pull Requests](#pull-requests)
12+
* [Commit Message Guidelines](#commit-message-guidelines)
13+
* [Commit Message Format](#commit-message-format)
14+
* [Header](#header)
15+
* [Type](#type)
16+
* [Short Description](#short-description)
17+
* [Body](#body)
18+
* [Footer](#footer)
19+
* [Commit Message Example](#commit-message-example)
20+
* [Style](#style)
1721

1822
<!-- tocstop -->
1923

2024
## Issues
2125

22-
- 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.)
2428

2529
## Pull Requests
2630

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.
3741

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.
3943

4044
## 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).
4245

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).
4347

4448
### Commit Message Format
49+
4550
Each commit message consists of a **header**, a **body** and a **footer**.
4651

47-
```
52+
```text
4853
<type>: <short description>
4954
<BLANK LINE>
5055
<body>
@@ -53,7 +58,9 @@ Each commit message consists of a **header**, a **body** and a **footer**.
5358
```
5459

5560
### Header
61+
5662
#### Type
63+
5764
Must be one of the following:
5865

5966
* **build**: Changes that affect the build system or external dependencies
@@ -67,32 +74,38 @@ Must be one of the following:
6774
* **test**: Adding missing tests or correcting existing tests
6875

6976
#### Short Description
77+
7078
Contains a succinct description of the change:
7179

7280
* use the imperative, present tense: "change" not "changed" nor "changes"
7381
* don't capitalize the first letter
7482
* no dot (.) at the end
7583

7684
### Body
85+
7786
Just as in the **short description**, use the imperative, present tense: "change" not "changed" nor "changes".
7887
The body should include the motivation for the change and contrast this with previous behavior.
7988

8089
### 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**.
8393

8494
### Commit Message Example
85-
```
95+
96+
```text
8697
fix: add debouncing to asset scroller to correct browser scroll position
8798
8899
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
90101
stability and usability with debouncing.
91102
92103
AB#17056
93104
```
94105

95106
## Style
96107

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
98109
this [guide](docs/STYLE.md) for more information.
110+
111+
Thank you!

0 commit comments

Comments
 (0)