@release-notes/schema - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

CODE_OF_CONDUCT.md

+# Contributor Covenant Code of Conduct
+
+## LT;DR
+
+* Everyone is welcome to be part of our community.
+* Be nice and respectful to each other.
+
+---
+
+The detailed version of our code of conduct can be found in our meta project.
+
+https://github.com/release-notes/release-notes/blob/develop/CODE_OF_CONDUCT.md

CONTRIBUTING.md

+# Contributing to Release Notes
+
+:sparkles::tada: Many thanks for contributing! :tada::sparkles:
+
+## LT;DR
+
+* Our mission is to build the best tooling around standardized release notes management.
+* Any contribution is welcome.
+* This project is committed to the following [CODE OF CONDUCT](CODE_OF_CONDUCT.md).
+* This project follows [git flow](http://nvie.com/posts/a-successful-git-branching-model/)
+* Releases are [semanticly versioned](http://semver.org/)
+* This is our [coding style](https://github.com/release-notes/eslint-config-release-notes)
+
+---
+
+The detailed version of our contributing guidelines can be found in our meta project.
+
+https://github.com/release-notes/release-notes/blob/develop/CONTRIBUTING.md

definitions/tag-list.json

+{
+  "$id": "@release-notes/tag-list",
+  "type": "array",
+  "items": {
+    "$ref": "tag"
+  }
+}

definitions/tag.json

+{
+  "$id": "@release-notes/tag",
+  "type": "string",
+  "minLength": 1
+}

index.js

+'use strict';
+
+const Modification = require('./definitions/modification.json');
+const ModificationList = require('./definitions/modification-list.json');
+const Release = require('./definitions/release.json');
+const ReleaseNotes = require('./definitions/release-notes.json');
+const Tag = require('./definitions/tag.json');
+const TagList = require('./definitions/tag-list.json');
+
+module.exports = {
+  Modification,
+  ModificationList,
+  Release,
+  ReleaseNotes,
+  Tag,
+  TagList,
+};

definitions/modification.json

@@ -15,2 +15,5 @@ {
           "type": "string"
+        },
+        "tags": {
+          "$ref": "tag-list"
         }
@@ -17,0 +20,0 @@ }

package.json

 {
   "name": "@release-notes/schema",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "JSON Schema definitions of the release-notes specification - an easy to use, human readable and machine processable schema for release notes.",
@@ -26,3 +26,4 @@ "author": "Alrik Zachert <[e-mail]>",
     "Alrik Zachert <[e-mail]>"
-  ]
+  ],
+  "main": "./index.js"
 }

README.md

 # Release Notes Schema
 
-**Title**   | Release Notes JSON-Schema
-:-----------|:-------------------------
-**Specification** | [Release Notes Draft 0.2.0](https://github.com/release-notes/release-notes-spec/blob/0.2.0/README.md)
-**License** | MIT
+[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/release-notes-schema)
+[![NPM Package](https://img.shields.io/npm/v/@release-notes/schema.svg)](https://www.npmjs.com/package/@release-notes/schema)
+[![MIT license](https://img.shields.io/github/license/release-notes/release-notes-schema.svg)](LICENSE)
 
@@ -11,4 +10,38 @@ # About
 The goal of this repository is to implement [JSON Schema Definitions](https://trac.tools.ietf.org/html/draft-wright-json-schema-validation-01)
-of the [Release Notes Spec](https://github.com/release-notes/release-notes-spec).
+of the [Release Notes Specification](https://github.com/release-notes/release-notes-spec).
 
+The following schemas are defined:
+
+* [ReleaseNotes](definitions/release-notes.json)
+* [Release](definitions/release.json)
+* [ModificationList](definitions/modification-list.json)
+* [Modification](definitions/modification.json)
+* [TagList](definitions/tag-list.json)
+* [Tag](definitions/tag.json)
+
+## Installation
+
+`$ npm i -S @release-notes/schema`
+
+## Usage
+
+```js
+const ReleaseNotesSchema = require('@release-notes/schema');
+
+console.info(
+  'Required fields of release notes: %s',
+  ReleaseNotesSchema.ReleaseNotes.required.join(', ')
+);
+```
+
+## Project Repositories
+
+The Release Notes project consists of the following repositories:
+   
+- [Release Notes Hub](https://github.com/release-notes/release-notes-hub)
+- [Release Notes CLI Tool](https://github.com/release-notes/release-notes-cli)
+- [Release Notes Node.js lib](https://github.com/release-notes/release-notes-node)
+- [Release Notes Specification](https://github.com/release-notes/release-notes-spec)
+- [Release Notes JSON-Schema Definitions](https://github.com/release-notes/release-notes-schema)
+
 ---
@@ -15,0 +48,0 @@

release-notes.yml

@@ -7,2 +7,8 @@ title: Release Notes of Release Notes Schema
 releases:
+- version: 0.2.0
+  date: 2017-10-30
+  improved:
+  - All schema definitions can be accessed from main package export.
+  added:
+  - Add support for tags on modifications.
 - version: 0.1.0
@@ -9,0 +15,0 @@ date: 2017-07-07T12:48:00Z

No alert changes

Improved metrics

Total package byte prevSize

7933

65.55%

Number of package files

13

62.5%

Lines of code

138

27.78%

Number of lines in readme file

53

165%

No dependency changes