Skip to content
This repository was archived by the owner on Oct 22, 2023. It is now read-only.

Commit 7220020

Browse files
committed
Finish 0.2.0
2 parents 7db3fc0 + 938fa2a commit 7220020

File tree

6 files changed

+60
-7
lines changed

6 files changed

+60
-7
lines changed

CODE_OF_CONDUCT.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## LT;DR
4+
5+
* Everyone is welcome to be part of our community.
6+
* Be nice and respectful to each other.
7+
8+
---
9+
10+
The detailed version of our code of conduct can be found in our meta project.
11+
12+
https://github.com/release-notes/release-notes/blob/develop/CODE_OF_CONDUCT.md

CONTRIBUTING.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contributing to Release Notes
2+
3+
:sparkles::tada: Many thanks for contributing! :tada::sparkles:
4+
5+
## LT;DR
6+
7+
* Our mission is to build the best tooling around standardized release notes management.
8+
* Any contribution is welcome.
9+
* This project is committed to the following [CODE OF CONDUCT](CODE_OF_CONDUCT.md).
10+
* This project follows [git flow](http://nvie.com/posts/a-successful-git-branching-model/)
11+
* Releases are [semanticly versioned](http://semver.org/)
12+
* This is our [coding style](https://github.com/release-notes/eslint-config-release-notes)
13+
14+
---
15+
16+
The detailed version of our contributing guidelines can be found in our meta project.
17+
18+
https://github.com/release-notes/release-notes/blob/develop/CONTRIBUTING.md

README.md

+23-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
# Release Notes Schema
22

3-
**Title** | Release Notes JSON-Schema
4-
:-----------|:-------------------------
5-
**Specification** | [Release Notes Draft 0.2.0](https://github.com/release-notes/release-notes-spec/blob/0.2.0/README.md)
6-
**License** | MIT
3+
[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/release-notes-schema)
4+
[![NPM Package](https://img.shields.io/npm/v/@release-notes/schema.svg)](https://www.npmjs.com/package/@release-notes/schema)
5+
[![MIT license](https://img.shields.io/github/license/release-notes/release-notes-schema.svg)](LICENSE)
76

87
# About
98

109
The goal of this repository is to implement [JSON Schema Definitions](https://trac.tools.ietf.org/html/draft-wright-json-schema-validation-01)
11-
of the [Release Notes Spec](https://github.com/release-notes/release-notes-spec).
10+
of the [Release Notes Specification](https://github.com/release-notes/release-notes-spec).
11+
12+
The following schemas are defined:
13+
14+
* [ReleaseNotes](definitions/release-notes.json)
15+
* [Release](definitions/release.json)
16+
* [ModificationList](definitions/modification-list.json)
17+
* [Modification](definitions/modification.json)
18+
* [TagList](definitions/tag-list.json)
19+
* [Tag](definitions/tag.json)
1220

1321
## Installation
1422

@@ -25,6 +33,16 @@ console.info(
2533
);
2634
```
2735

36+
## Project Repositories
37+
38+
The Release Notes project consists of the following repositories:
39+
40+
- [Release Notes Hub](https://github.com/release-notes/release-notes-hub)
41+
- [Release Notes CLI Tool](https://github.com/release-notes/release-notes-cli)
42+
- [Release Notes Node.js lib](https://github.com/release-notes/release-notes-node)
43+
- [Release Notes Specification](https://github.com/release-notes/release-notes-spec)
44+
- [Release Notes JSON-Schema Definitions](https://github.com/release-notes/release-notes-schema)
45+
2846
---
2947

3048
### LICENSE

index.js

+4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ const Modification = require('./definitions/modification.json');
44
const ModificationList = require('./definitions/modification-list.json');
55
const Release = require('./definitions/release.json');
66
const ReleaseNotes = require('./definitions/release-notes.json');
7+
const Tag = require('./definitions/tag.json');
8+
const TagList = require('./definitions/tag-list.json');
79

810
module.exports = {
911
Modification,
1012
ModificationList,
1113
Release,
1214
ReleaseNotes,
15+
Tag,
16+
TagList,
1317
};

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@release-notes/schema",
3-
"version": "0.1.0",
3+
"version": "0.2.0",
44
"description": "JSON Schema definitions of the release-notes specification - an easy to use, human readable and machine processable schema for release notes.",
55
"author": "Alrik Zachert <[email protected]>",
66
"keywords": [

release-notes.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ description: >
44
an easy to use, human readable and machine processable schema for release notes.
55
66
releases:
7-
- version: Next
7+
- version: 0.2.0
8+
date: 2017-10-30
89
improved:
910
- All schema definitions can be accessed from main package export.
1011
added:

0 commit comments

Comments
 (0)