linterhub.schema
Repository of all schemas for JSON structures for repositories of linterhub.
Information about schemas reead following folder src\schema
.
Table of Contents
Background
In our projects, we often use many JSON Objects for work. For each object needs to make tests and changes. After the discussion ended up, proposed to use JSON Objects in a separate repository for convenience and working with.
But many projects can use one JSON object and when JSON is updated, need for that projects working is fine. The decision of this trouble is semantic releases.
Finally, we have a lot of JSON Objects, schemes and tests for them and semantic release. Then after we create this repository based on the teamplate of the organization linterhub.
Install
Requirements:
-
Node.js
- JavaScript runtime built on Chrome's V8 JavaScript engine.
Step 1
For begin work with this repository, you need to clone or fork it before.
Clone repository:
git clone https://github.com/linterhub/schema.git
More information about cloning you can read in help github
Fork repository:
Open this repository in github and click the Fork
button. Than follow the GitHub documentation for forking and cloning.
Step 2
This repository using 2 submodules: SPDX
and linguist
. For stable work need to initialize and update they.
Init and update submodule(s):
git submodule init
git submodule update
More information about work with submodule(s) you can read in git-scm
Step 3
For running commands of the project need to install npm package
Install npm package:
npm install
That's all.
Usage
For creating last of version schemas run next command:
gulp build
Result of running is building schemas to folder build
.
Maintainers
These amazing people are maintaining this project: @linterhub/maintainers
Contribute
You may contribute in several ways like creating new features, tests, fixing bugs, improving documentation or examples. Find more information in CONTRIBUTING.md.
License
MIT © 2018 linterhub