formatting

This commit is contained in:
Nathaniel V. KELSO 2012-06-05 21:48:21 -07:00
parent a98cd3a41f
commit 14a50d5680

View File

@ -34,22 +34,22 @@ The 2.0 release in 2012 marked the project's shift from so-called marketing vers
Natural Earth is a big project with hundreds of files that depend on each other and the total weighs in at several gigabytes. SemVer is a simple set of rules and requirements around version numbers. For our project, the data layout is the API. Natural Earth is a big project with hundreds of files that depend on each other and the total weighs in at several gigabytes. SemVer is a simple set of rules and requirements around version numbers. For our project, the data layout is the API.
* Version format of X.Y.Z (Major.Minor.Patch). * **Version format of X.Y.Z** (Major.Minor.Patch).
* Changing existing data file names, major version X will be incremented. * Changing existing data file names, major version X will be incremented.
* Changing existing data column (field) names, major version X will be incremented. * Changing existing data column (field) names, major version X will be incremented.
* Removing `FeatureCla` field attribute values, major version X will be incremented. * Removing `FeatureCla` field attribute values, major version X will be incremented.
* Introduce significatnt new content, major version X will be incremented. * Introduce significatnt new content, major version X will be incremented.
* Bug fixes not affecting the file and field names, patch version Z will be incremented. * **Bug fixes** not affecting the file and field names, patch version Z will be incremented.
* Backwards compatible API additions/changes, increment the minor version Y * **Backwards compatible** API additions/changes, increment the minor version Y
* Backwards incompatible API changes, increment the major version X. * **Backwards incompatible** API changes, increment the major version X.
Under this scheme, version numbers and the way they change convey meaning about the underlying code and what has been modified from one version to the next. Under this scheme, version numbers and the way they change convey meaning about the underlying code and what has been modified from one version to the next.
When we introduce a new version of Natural Earth, you can tell by the version number how much effort you will need to extend to integrate the data with your map implementation. When we introduce a new version of Natural Earth, you can tell by the version number how much effort you will need to extend to integrate the data with your map implementation.
* Bug fixes Z: can simply use the new data files, replacing your old files. * **Bug fixes Z**: can simply use the new data files, replacing your old files.
* Minor version Y: limited integration challenges, primarily around leveraging new content. * **Minor version Y**: limited integration challenges, primarily around leveraging new content.
* Major version X: significatnt integration challenges, either around changed file strucutre, field layout, field values like `FeatureCla` used in symbolizing data, or significant new additions or significant changes to existing themes. * **Major version X**: significatnt integration challenges, either around changed file strucutre, field layout, field values like `FeatureCla` used in symbolizing data, or significant new additions or significant changes to existing themes.
#&etc #&etc