Skip to content

Commit dc57efb

Browse files
committed
Adds CONTRIBUTING LICENSE
1 parent 6966cfd commit dc57efb

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Contribution Guide
3+
---
4+
5+
# Contributing to jekyll-sqlite
6+
7+
**This document is a work-in-progress.**
8+
9+
This doc is a short introduction on how to modify and maintain the sqlite3-ruby gem.
10+
11+
## Making a Release
12+
13+
0. Update `version.rb`
14+
0. Update CHANGELOG.md
15+
1. Run `bundle exec rake rubocop` to lint
16+
2. Commit + push
17+
3. If build passes, tag and push the tag.
18+
19+
Gem publication on rubygems automatically happens via GitHub Actions.
20+
21+
## Running Tests
22+
23+
`bundle exec rake test`
24+
25+
## Test Infrastructure
26+
27+
The tests are maintained in `test` directory as a separate jekyll website.
28+
The site is built inside `Rakefile`, and it uses JSON output files as templates.
29+
30+
These JSON output files can then be used for testing the plugin.
31+
32+
## Rubocop
33+
34+
Linting is mandatory to pass the CI.
35+
36+
## Docs
37+
38+
Docs are maintained in docs/ directory as a separate Jekyll site that uses
39+
just-the-docs theme. A few markdown files are symlinked inside docs so that
40+
they get published to the website as well.
41+
42+
## Demo
43+
44+
The demo is maintained separately on another repo, but the expectation is that
45+
all important features are used in the demo. If you contribute such a change
46+
that adds a new feature, please update the demo as well.

LICENSE

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The MIT License (MIT)
2+
Copyright (c) Nemo
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
6+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7+
8+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)