Skip to content

Commit 7846dfd

Browse files
committed
Improve formatting and fix some typos
1 parent 227804e commit 7846dfd

File tree

6 files changed

+18
-10
lines changed

6 files changed

+18
-10
lines changed

.gitattributes

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,7 @@
2020
*.ico binary
2121
*.snk binary
2222
*.pdb binary
23-
*.svg binary
23+
*.svg binary
24+
25+
# Don't check for trailing whitespace at end of lines in the doc pages
26+
*.md -whitespace=blank-at-eol

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
# User-specific files
99
*.suo
1010
*.user
11+
*.userprefs
1112
*.sln.docstates
1213
*.pidb
1314
*.received.txt
@@ -62,7 +63,9 @@ TestResults
6263
ClientBin
6364
stylecop.*
6465
~$*
66+
*~
6567
*.dbmdl
68+
site/
6669
Generated_Code #added for RIA/Silverlight projects
6770

6871
# Backup & report files from converting an old project file to a newer

docs/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ branches:
3838
```
3939
4040
The options in here are:
41+
4142
- `mode`: Same as above
4243
- `tag`: The pre release tag to use for this branch. Use the value `use-branch-name-as-tag` to use the branch name instead.
4344
For example `feature/foo` would become a pre-release tag of `foo` with this value

docs/reference/continuous-delivery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ In essence continuous delivery means:
88
- Your code is automatically built and tested
99
- If any of the automated tests fail, the teams #1 priority is to fix the build
1010
- If the build is green, the application can be deployed at any time
11-
- Ideally the buisiness should make that decision
11+
- Ideally the business should make that decision
1212
- The same artifacts which were built and tested should be deployed
1313
- That means no rebuilding everything when you are deploying
1414

docs/reference/intro-to-semver.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ Version Promiscuity is the opposite problem, **JsonLibrary** releases _v1.1.0_ w
1010

1111
SemVer introduces conventions about breaking changes into our version numbers so we can safely upgrade dependencies without fear of unexpected breaking changes while still allowing us to upgrade downstream libraries to get new features and bug fixes. The convention is quite simple.
1212

13-
{major}.{minor}.{patch}-{tag}+{buildmetadata}
14-
{major} = Only incremented if the release has breaking changes (includes bug fixes which have breaking behavioural changes
15-
{minor} = Incremented if the release has new non-breaking features
16-
{patch} = Incremented if the release only contains non-breaking bug fixes
17-
{tag} = Optional -{tag} denotes a pre-release of the version preceeding
18-
{buildmetadata} = Options +{buildmetadata} contains additional information about the version, but DOES NOT AFFECT the semantic version preceding it.
13+
**{major}.{minor}.{patch}-{tag}+{buildmetadata}**
14+
**{major}** = Only incremented if the release has breaking changes (includes bug fixes which have breaking behavioural changes)
15+
**{minor}** = Incremented if the release has new non-breaking features
16+
**{patch}** = Incremented if the release only contains non-breaking bug fixes
17+
**{tag}** = Optional -{tag} denotes a pre-release of the version preceeding
18+
**{buildmetadata}** = Options +{buildmetadata} contains additional information about the version, but DOES NOT AFFECT the semantic version preceding it.
1919

2020
Only one number should be incremented per release, and all lower parts should be reset to 0 (if major is incrememented then minor and patch should become 0).
2121

22-
For a more complete explaination checkout [semver.org](http://semver.org) which is the official spec. Remember this is a breif introduction and does not cover all parts of semantic versioning, just the important parts to get started.
22+
For a more complete explaination checkout [semver.org](http://semver.org) which is the official spec. Remember this is a brief introduction and does not cover all parts of semantic versioning, just the important parts to get started.
2323

2424
## SemVer in GitVersion
2525
GitVersion makes it easy to follow semantic versioning in your library by automatically calculating the next semantic version which your library/application is likely to use. In GitFlow the develop branch will bump the *minor* when master is tagged, while GitHubFlow will bump the *patch*.
2626

27-
Because one side does not always fit all, GitVersion provides many [Variables](../more-info/variables.md) for you to use which contain different variations of the version. For example SemVer will be in the format {major}.{minor}.{patch}-{tag}, but FullSemVer will also include build metadata: {major}.{minor}.{patch}-{tag}+{buildmetadata}
27+
Because one side does not always fit all, GitVersion provides many [Variables](../more-info/variables.md) for you to use which contain different variations of the version. For example `SemVer` will be in the format {major}.{minor}.{patch}-{tag}, but `FullSemVer` will also include build metadata: {major}.{minor}.{patch}-{tag}+{buildmetadata}

docs/why.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
GitVersion makes versioning woes a thing of the past. It looks at your git history to calculate what the version currently is. I have seen and used many different approaches in the past, all have downfalls and often are not transportable between projects.
33

44
It solves:
5+
56
- Rebuilding tags always produces the same version
67
- Not having to rebuild to increment versions
78
- Not duplicating version information in multiple places (branch release/2.0.0 already has the version in it, why do I need to change something else)

0 commit comments

Comments
 (0)