Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
lqez committed Dec 28, 2019
2 parents c72fd62 + e6f048d commit 07c8200
Show file tree
Hide file tree
Showing 255 changed files with 38,352 additions and 28,097 deletions.
1 change: 1 addition & 0 deletions .eslintrc
Expand Up @@ -4,6 +4,7 @@
"chai-friendly"
],
"rules": {
"indent": ["warn", 2, {"ArrayExpression": "off", "SwitchCase": 1}],
"semi": [2, "always"],
"space-before-function-paren": ["error", "never"],
"no-useless-escape": 0,
Expand Down
38 changes: 28 additions & 10 deletions .github/CONTRIBUTING.md
Expand Up @@ -13,15 +13,13 @@ npm install
# build full version of summernote: dist/summernote.js
npm run build

# generate minified copy: dist/summernote.min.js, dist/summernote.css
npm run dist
```
At this point, you should now have a `build/` directory populated with everything you need to use summernote.
At this point, you should now have a `dist/` directory populated with everything you need to use summernote.

## Start local server for developing summernote.
run local server with connect and watch.
run local server with webpack-dev-server and watch.
```bash
npm run start
npm run dev
# Open a browser on http://localhost:3000.
# If you change source code, automatically reload your page.
```
Expand All @@ -32,7 +30,7 @@ run tests with Karma and PhantomJS
npm run test
```
If you want run tests on other browser,
change the values for `broswers` properties in `karma.conf.js`.
change the values for `browsers` properties in `karma.conf.js`.

```
karma: {
Expand All @@ -43,9 +41,29 @@ karma: {
}
```

Or, pass `--browsers` argument via `npm run test` command.
```
$ npm run test -- --browsers Safari,Firefox
```

You can use `Chrome`, `ChromeCanary`, `Firefox`, `Opera`, `Safari`, `PhantomJS` and `IE` beside `PhantomJS`.
Once you run `npm test`, it will watch all javascript file. Therefore karma run tests every time you change code.

## Test a part of test

If you would like to run some part of your test codes, use the watch mode.

```bash
$ npm run test:watch
```

`karma` will run test and keep waiting other test requests. And then, run `test:grep` in another terminal. Below shows how to run `LinkDialog` related tests only.

```bash
$ npm run test:grep LinkDialog
```

## Prepush Hooks
As part of this repo, we use the NPM package husky to implement git hooks. We leverage the prepush hook to prevent bad commits.

Expand All @@ -61,7 +79,7 @@ As part of this repo, we use the NPM package husky to implement git hooks. We le
```

1. A body container has block node, but `<ul>` has only `<li>` nodes.
2. A body container also has inline nodes sometimes. This inline nodes will be wrapped with `<p>` when enter key pressed.
4. A block node only has inline nodes.
5. A inline nodes has another inline nodes
6. `#text` and void inline node doesn't have children.
1. A body container also has inline nodes sometimes. This inline nodes will be wrapped with `<p>` when enter key pressed.
1. A block node only has inline nodes.
1. A inline nodes has another inline nodes
1. `#text` and void inline node doesn't have children.
8 changes: 8 additions & 0 deletions .github/FUNDING.yml
@@ -0,0 +1,8 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
custom: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=S8F8AAD3YSD6Q&source=url
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE.md
@@ -1,5 +1,7 @@
Before submitting an issue, please make sure to search for already open issues, and add to that. This way we can track issues more easily. Thank you, and Thanks for using Summernote.

Please answer the below questions, this will help us to more easily resolve whatever issues you are having, and direct issue to the suitable people to with your issue or to give you correct answers.

#### Description of your Issue or Request:
Please provide a short description of the issue or request. If you don't provide one, we can't expedite helping to fix your issue or fullfill your request.

Expand All @@ -17,9 +19,7 @@ This can help find and resolve any issues.

2. Browser and Version:

3. Summernote Version:

4. Bootstrap Version or Lite:
3. Summernote Version (including which BS3, BS4, Lite or All):


#### screenshot of issue
Expand Down
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,3 +1,6 @@
Thank you for taking the time to help us improve Summernote.
Please be sure that you are not submitting changes made to the files in the `dist/` folder, and only to the files contained in the `src/` folder.

#### What does this PR do?

- awesome stuff
Expand Down
6 changes: 5 additions & 1 deletion .gitignore
Expand Up @@ -47,4 +47,8 @@ test/reports/
selenium-debug.log

# Ignoring rpt2_cache
.rpt2_cache
.rpt2_cache

# direnv
.envrc
.env
1 change: 0 additions & 1 deletion .travis.yml
Expand Up @@ -28,6 +28,5 @@ deploy:
addons:
sauce_connect:
username: 'summernoteis'
access_key: '3d57fd7c-72ea-4c79-8183-bbd6bfa11cc3'
after_success:
- npm run coveralls
201 changes: 0 additions & 201 deletions Gruntfile.js

This file was deleted.

23 changes: 16 additions & 7 deletions MAINTAIN.md
Expand Up @@ -5,19 +5,28 @@
Send pull request `develop` to `master` on github repository and merge it.
https://github.com/summernote/summernote/compare/master...develop


### 2. Build dist files

Build dist files and push to master
```bash
# change branch
git checkout master

# fetch all changes
git pull

# Bump version in package.json

# build dist files and binary(.zip) for release post
grunt dist
# Push new dist files to remote repository.
npm run build

# Commit and add tag for new version
git commit -a -m "Update dist files"
git push origin
git tag -a "<new-version>"

# Push new dist files and tags to remote repository.
git push origin --tags
```

### 3. Release new version
Expand All @@ -32,8 +41,8 @@ Publish on npm
npm publish
```

### 05. Update summernote.github.io
Update summernote version in _config.yml.
### 5. Update summernote.github.io
Update summernote version in `_config.yml`.

### 06. Update connector
- [summernote-rails](https://github.com/summernote/summernote-rails/blob/master/MAINTAIN.md)
### 6. Update connectors
Request maintainers of each connector to update package information.

0 comments on commit 07c8200

Please sign in to comment.