Browse Source

Added standardized changelog file.

tags/2.6.0
Jeroen Akkerman 7 months ago
parent
commit
087bc8cfed
3 changed files with 111 additions and 4 deletions
  1. 106
    0
      CHANGELOG.md
  2. 4
    3
      CONTRIBUTING.md
  3. 1
    1
      gulpfile.js

+ 106
- 0
CHANGELOG.md View File

@@ -0,0 +1,106 @@
# EasyMDE Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## Added
- Contributing guide (Thanks to @roipoussiere, #54).
- Issue templates.
- Standardized changelog file.

## Changed
- Finish rewrite of README (Thanks to @roipoussiere, #54).
- Image and link prompt fill with "https://" by default.
- Link to markdown guide to https://www.markdownguide.org/basic-syntax/.

## Fixed
- Backwards compatibility in the API with SimpleMDE 1.0.0 (#41).
- Automatic publish of master branch to `@next`

## Removed
- Distribution files from source-control.

## [2.5.1] - 2019-01-17
### Fixed
- `role="button"` needed to be `type="button"`, fixes #45.

## [2.5.0] - 2019-01-17
### Added
- Typescript support (Thanks to @FranklinWhale, #44).
- `role="button"` to toolbar buttons (#38).

### Fixed
- Eraser icon not working with FontAwesome 5.

## [2.4.2] - 2018-11-09
### Added
- Node.js 11 support.

### Fixed
- Header button icons not showing sub-icons with FontAwesome 5.
- Inconsistent autosave behaviour when submitting a form (Thanks to @Furgas and @adamb70, #31).

## [2.4.1] - 2018-10-15
### Added
- `fa-redo` class to redo button for FA5 compatibility (Thanks to @Summon528, #27).

## [2.4.0] - 2018-10-15
### Added
- Theming support (Thanks to @LeviticusMB, #17).
- onToggleFullscreen event hook (Thanks to @n-3-0, #16).

### Fixed
- Fullscreen not working with `toolbar: false` (Thanks to @aphitiel, #19).

## [2.2.2] - 2019-07-03
### Fixed
- Automatic publish only publishing tags.

## [2.2.1] - 2019-06-29 [YANKED]
### Changed
- Attempt automatic publish `@next` version on npm.
- Links in the preview window will open in a new tab by default.

### Fixed
- Multi-text select issue by disabling multi-select in the editor (#10).
- `main` file in package.json (Thanks to @sne11ius, #11).

## [2.0.1] - 2018-05-13
### Changed
- Rewrote part of the documentation for EasyMDE.
- Updated gulp to version 4.0.0.

### Fixed
- Icons for `heading-smaller`, `heading-bigger`, `heading-1`, `heading-2` and `heading-3` not showing (#9).

## [2.0.0] - 2018-04-23
Project forked from [SimpleMDE](https://github.com/sparksuite/simplemde-markdown-editor)

### BREAKING CHANGES
- Dropped Bower support.
- Dropped support for older Node.js versions.

### Added
- FontAwesome 5 support.
- Support for newer Node.js versions.

### Changed
- Packages are now version-locked.
- Simplified build script.
- Markdown guide button is no longer disabled in preview mode.

### Fixed
- Cursor not always showing in "text" mode over the edit field

[Unreleased]: https://github.com/Ionaru/easy-markdown-editor/compare/2.5.1...HEAD
[2.5.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.5.0...2.5.1
[2.5.0]: https://github.com/Ionaru/easy-markdown-editor/compare/2.4.2...2.5.0
[2.4.2]: https://github.com/Ionaru/easy-markdown-editor/compare/2.4.1...2.4.2
[2.4.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.4.0...2.4.1
[2.4.0]: https://github.com/Ionaru/easy-markdown-editor/compare/2.2.2...2.4.0
[2.2.2]: https://github.com/Ionaru/easy-markdown-editor/compare/2.2.1...2.2.2
[2.2.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.0.1...2.2.1
[2.0.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.0.0...2.0.1
[2.0.0]: https://github.com/Ionaru/easy-markdown-editor/compare/1.11.2...2.0.0

+ 4
- 3
CONTRIBUTING.md View File

@@ -52,10 +52,11 @@ Yay! You are ready! 🍾
2. a) If you already cloned and worked on the project: `git remote add source https://github.com/Ionaru/easy-markdown-editor.git`;
b) Otherwise, clone your fork: `git clone https://github.com/YOUR_USERNAME/easy-markdown-editor.git`;
3. Create a new dedicated branch `git checkout -b myMergeRequest`;
4. Write some nice code and commit your work;
4. Write some nice code and commit your work. (Don't forget to add your changes to the changelog!);
5. Check files against the ESLint syntax and build minified versions: `gulp`;
6. Push it to a dedicated branch `git push origin myMergeRequest`;
7. Go to the [main project page](https://github.com/Ionaru/easy-markdown-editor) and click on the button *Compare and pull request*, then fill the description.
6. Test your changes;
7. Push it to a dedicated branch `git push origin myMergeRequest`;
8. Go to the [main project page](https://github.com/Ionaru/easy-markdown-editor) and click on the button *Compare and pull request*, then fill the description.

If you want to make other pull requests, go back to the master branch (`git checkout master`), update it (`git pull --rebase source master`), then follow the instructions above from step 3.


+ 1
- 1
gulpfile.js View File

@@ -40,7 +40,7 @@ function styles() {
var css_files = [
'./node_modules/codemirror/lib/codemirror.css',
'./src/css/*.css',
'./node_modules/codemirror-spell-checker/src/css/spell-checker.css'
'./node_modules/codemirror-spell-checker/src/css/spell-checker.css',
];

return gulp.src(css_files)

Loading…
Cancel
Save