Sha256: 27d4b5b7215bed7df943351220ebfe66fa350de371c7b5cedff75bd418a38149

Contents?: true

Size: 1.6 KB

Versions: 4

Compression:

Stored size: 1.6 KB

Contents

<%= @project_name.capitalize %> Data Dictionary
======================

[![Build Status](https://travis-ci.com/<REPOSITORY>/<%= @project_name.downcase %>-data-dictionary.svg?branch=master)](https://travis-ci.com/<REPOSITORY>/<%= @project_name.downcase %>-data-dictionary)

### Exports

The <%= @project_name.downcase %> data dictionary can be exported to CSV by typing:

```
spout export
```

The `spout export` command will generate CSV files that describe the data
dictionary.


### Testing

The <%= @project_name.downcase %> data dictionary is tested using the
[Spout Gem](https://github.com/sleepepi/spout).

Data dictionary tests can be run by typing:

```
spout test
```


### Releases

The data dictionary is tagged at various time points using
[Git tags](http://git-scm.com/book/en/Git-Basics-Tagging). The tags are used to
reference a series of CSV files that correspond to the data dictionary itself.

For example, CSV files of the underlying data that have been tagged as `v0.1.0`
will be compatible with the Data Dictionary `~> 0.1.0`,
(including `0.1.1`, `0.1.2`, `0.1.3`). However if the data dictionary contains
changes to the underlying dataset, then the minor version number is bumped, and
the patch level is reset to zero. If, for example, the CSV dataset changed to
`v0.2.0`, then it would be compatible with `0.2.0`, `0.2.1`, `0.2.2`, etc. The
approach for changing version numbers uses a variation on
[Semantic Versioning](http://semver.org).

A full list of changes for each version can be viewed in the
[CHANGELOG](https://github.com/<REPOSITORY>/<%= @project_name.downcase %>-data-dictionary/blob/master/CHANGELOG.md).

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
spout-1.0.0 lib/spout/templates/README.md.erb
spout-1.0.0.beta3 lib/spout/templates/README.md.erb
spout-1.0.0.beta2 lib/spout/templates/README.md.erb
spout-1.0.0.beta1 lib/spout/templates/README.md.erb