Skip to content

Commit 8ffc28a

Browse files
authored
Update versioning-guide.md
1 parent a8cac29 commit 8ffc28a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/Versioning/versioning-guide.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ Versioning can be implemented in one or two ways, depending on the situation:
55
1. by adding the required information to a `Versioning_XX.json` file; and/or
66
2. by adding a `PreviousVersion` attribute to your changed method.
77

8-
The choice of the appropriate one depends on the change you are doing, as explained in detail in the following sections. BHoM Versioning supports:
8+
The choice of the appropriate one depends on the change you are doing, as explained in detail in the following sections.
9+
10+
## Supported changes
11+
BHoM Versioning supports:
912

1013
- Changes to methods (e.g. saved in a script):
1114
- changes in the method name
@@ -440,9 +443,9 @@ The empty file should then be immediately populated with the following content (
440443
Then you can fill it in as described by the relevant "changes" section.
441444

442445
### Why having a `Versioning_XX.json` file?
443-
BHoM Versioning is implemented via a specific, stand-alone mechanism, hosted in the Versioning_Toolkit.
446+
BHoM Versioning is implemented via a specific, stand-alone mechanism, hosted in the [Versioning_Toolkit](https://github.com/BHoM/Versioning_Toolkit).
444447

445-
The information related to the changes to the current BHoM version are stored locally at the root of each project where the change occurred, so that everyone can independently change BHoM objects or methods without the need to modify the Versioning_Toolkit.
448+
By adding a `Versioning_XX.json` file, the information related to code changes are stored locally in each project where the change occurred. This enables _decentralisation_, i.e. many people can independently code and change BHoM objects or methods in different Toolkits without the need to modify the Versioning_Toolkit, avoiding clashes.
446449

447450

448451
# Troubleshooting on Versioning

0 commit comments

Comments
 (0)