Skip to content

Commit d854d08

Browse files
committed
docs: improve README.md
1 parent af7a86c commit d854d08

File tree

3 files changed

+25
-2
lines changed

3 files changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
11
# GitExtensions AzureDevOpsCommitMessage Plugin
2-
GitExtensions plugin to get template commit messages generated based on Azure Devops Work items.
2+
GitExtensions plugin to get template commit messages generated based on Azure Devops Work items inside [GitExtensions](https://github.com/gitextensions/gitextensions) commit form
33

4-
The default request generate templates for the PBIs and Bugs of the current sprint for the authenticated user.
4+
**The default request generate templates for the PBIs and Bugs of the current sprint for the authenticated user.**
55

66
The package is going to be published on [NuGet.org](https://www.nuget.org/packages/GitExtensions.AzureDevOpsCommitMessage) feed.
7+
8+
## Versions
9+
10+
* v5.0 : Compatible with GitExtensions >= v5.0
11+
* v2.0 : Compatible with GitExtensions < v5.0
12+
13+
## Configuration
14+
15+
1. Open AzureDevOpsCommitMessage plugin settings
16+
2. Update settings:
17+
* Set ADO project url
18+
* Set user e-mail
19+
* Generate and set an ADO Personal access token (with "Work items (read)" right).
20+
3. Run the preview to check that it is working (no error occurred) and eventually that the WIQL query is doing what you expect
21+
4. Apply settings
22+
23+
## Screenshots
24+
25+
* Settings:
26+
![Settings](./assets/PluginsSettingsScreenshot.png)
27+
28+
* Commit messages:
29+
![Commit messages](./assets/ADOCommitTemplatesScreenshots.png)
26.3 KB
Loading
57.2 KB
Loading

0 commit comments

Comments
 (0)