Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
fengyuanchen committed Mar 11, 2018
1 parent 33759b6 commit 64a9825
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 38 deletions.
40 changes: 7 additions & 33 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,41 +140,9 @@ To ensure consistency throughout the source code, keep these rules in mind as yo

## Commit Message Guidelines

### Examples

Appears under "Features" header, icon subheader:

```
feat: enhance the `preview` option
```

Appears under "Bug Fixes" header, icon subheader, with a link to issue #1:

```
fix: enforce type checking
Closes #1
```

Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:

```
perf: remove `preview` option
BREAKING CHANGE: The `preview` option has been removed for performance reason.
```

The following commit and commit `6eecc6e` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.

```
revert: feat: enhance the `preview` option
This reverts commit 6eecc6ecf005e9094f1cd2c184204040db73d723.
```

### Commit Message Format

A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:

```
<type>(<scope>): <subject>
Expand All @@ -186,6 +154,12 @@ A commit message consists of a **header**, **body** and **footer**. The header

The **header** is mandatory and the **scope** of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.

Here are some [samples](https://github.com/fengyuanchen/lifecycle.js/commits/master).

### Revert

If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ jquery-cropper version: X.Y.Z
<!-- Check whether this is still an issue in the most recent jquery-cropper version -->

Browser:

- [ ] Chrome (desktop) version XX
- [ ] Chrome (Android) version XX
- [ ] Chrome (iOS) version XX
Expand All @@ -57,5 +56,5 @@ Browser:
- [ ] Edge version XX

Others:
<!-- Anything else relevant? Operating system version, IDE, package manager, HTTP server, ... -->
<!-- Anything else relevant? -->
</code></pre>
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dist/

## Getting started

### Install
### Installation

```shell
npm install jquery-cropper jquery cropperjs
Expand Down
3 changes: 1 addition & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="A jQuery plugin wrapper for Cropper.js.">
<meta name="keywords" content="HTML, CSS, JS, JavaScript, jQuery plugin, image cropping, image crop, image move, image zoom, image rotate, image scale, front-end, frontend, web development">
<meta name="author" content="Chen Fengyuan">
<title>jquery-cropper</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
Expand Down Expand Up @@ -568,8 +567,8 @@ <h5 class="modal-title" id="getCroppedCanvasTitle">Cropped</h5>
<!-- Scripts -->
<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.bundle.min.js"></script>
<script src="https://unpkg.com/cropperjs/dist/cropper.js"></script>
<script src="https://fengyuanchen.github.io/js/common.js"></script>
<script src="https://unpkg.com/cropperjs/dist/cropper.js"></script>
<script src="js/jquery-cropper.js"></script>
<script src="js/main.js"></script>
</body>
Expand Down

0 comments on commit 64a9825

Please sign in to comment.