Browse Source

Added standardized changelog file.

tags/2.6.0
Jeroen Akkerman 5 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 @@
1
+# EasyMDE Changelog
2
+All notable changes to this project will be documented in this file.
3
+
4
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+## [Unreleased]
8
+## Added
9
+- Contributing guide (Thanks to @roipoussiere, #54).
10
+- Issue templates.
11
+- Standardized changelog file.
12
+
13
+## Changed
14
+- Finish rewrite of README (Thanks to @roipoussiere, #54).
15
+- Image and link prompt fill with "https://" by default.
16
+- Link to markdown guide to https://www.markdownguide.org/basic-syntax/.
17
+
18
+## Fixed
19
+- Backwards compatibility in the API with SimpleMDE 1.0.0 (#41).
20
+- Automatic publish of master branch to `@next`
21
+
22
+## Removed
23
+- Distribution files from source-control.
24
+
25
+## [2.5.1] - 2019-01-17
26
+### Fixed
27
+- `role="button"` needed to be `type="button"`, fixes #45.
28
+
29
+## [2.5.0] - 2019-01-17
30
+### Added
31
+- Typescript support (Thanks to @FranklinWhale, #44).
32
+- `role="button"` to toolbar buttons (#38).
33
+
34
+### Fixed
35
+- Eraser icon not working with FontAwesome 5.
36
+
37
+## [2.4.2] - 2018-11-09
38
+### Added
39
+- Node.js 11 support.
40
+
41
+### Fixed
42
+- Header button icons not showing sub-icons with FontAwesome 5.
43
+- Inconsistent autosave behaviour when submitting a form (Thanks to @Furgas and @adamb70, #31).
44
+
45
+## [2.4.1] - 2018-10-15
46
+### Added
47
+- `fa-redo` class to redo button for FA5 compatibility (Thanks to @Summon528, #27).
48
+
49
+## [2.4.0] - 2018-10-15
50
+### Added
51
+- Theming support (Thanks to @LeviticusMB, #17).
52
+- onToggleFullscreen event hook (Thanks to @n-3-0, #16).
53
+
54
+### Fixed
55
+- Fullscreen not working with `toolbar: false` (Thanks to @aphitiel, #19).
56
+
57
+## [2.2.2] - 2019-07-03
58
+### Fixed
59
+- Automatic publish only publishing tags.
60
+
61
+## [2.2.1] - 2019-06-29 [YANKED]
62
+### Changed
63
+- Attempt automatic publish `@next` version on npm.
64
+- Links in the preview window will open in a new tab by default.
65
+
66
+### Fixed
67
+- Multi-text select issue by disabling multi-select in the editor (#10).
68
+- `main` file in package.json (Thanks to @sne11ius, #11).
69
+
70
+## [2.0.1] - 2018-05-13
71
+### Changed
72
+- Rewrote part of the documentation for EasyMDE.
73
+- Updated gulp to version 4.0.0.
74
+
75
+### Fixed
76
+- Icons for `heading-smaller`, `heading-bigger`, `heading-1`, `heading-2` and `heading-3` not showing (#9).
77
+
78
+## [2.0.0] - 2018-04-23
79
+Project forked from [SimpleMDE](https://github.com/sparksuite/simplemde-markdown-editor)
80
+
81
+### BREAKING CHANGES
82
+- Dropped Bower support.
83
+- Dropped support for older Node.js versions.
84
+
85
+### Added
86
+- FontAwesome 5 support.
87
+- Support for newer Node.js versions.
88
+
89
+### Changed
90
+- Packages are now version-locked.
91
+- Simplified build script.
92
+- Markdown guide button is no longer disabled in preview mode.
93
+
94
+### Fixed
95
+- Cursor not always showing in "text" mode over the edit field
96
+
97
+[Unreleased]: https://github.com/Ionaru/easy-markdown-editor/compare/2.5.1...HEAD
98
+[2.5.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.5.0...2.5.1
99
+[2.5.0]: https://github.com/Ionaru/easy-markdown-editor/compare/2.4.2...2.5.0
100
+[2.4.2]: https://github.com/Ionaru/easy-markdown-editor/compare/2.4.1...2.4.2
101
+[2.4.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.4.0...2.4.1
102
+[2.4.0]: https://github.com/Ionaru/easy-markdown-editor/compare/2.2.2...2.4.0
103
+[2.2.2]: https://github.com/Ionaru/easy-markdown-editor/compare/2.2.1...2.2.2
104
+[2.2.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.0.1...2.2.1
105
+[2.0.1]: https://github.com/Ionaru/easy-markdown-editor/compare/2.0.0...2.0.1
106
+[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! 🍾
52 52
 2. a) If you already cloned and worked on the project: `git remote add source https://github.com/Ionaru/easy-markdown-editor.git`;
53 53
 b) Otherwise, clone your fork: `git clone https://github.com/YOUR_USERNAME/easy-markdown-editor.git`;
54 54
 3. Create a new dedicated branch `git checkout -b myMergeRequest`;
55
-4. Write some nice code and commit your work;
55
+4. Write some nice code and commit your work. (Don't forget to add your changes to the changelog!);
56 56
 5. Check files against the ESLint syntax and build minified versions: `gulp`;
57
-6. Push it to a dedicated branch `git push origin myMergeRequest`;
58
-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.
57
+6. Test your changes;
58
+7. Push it to a dedicated branch `git push origin myMergeRequest`;
59
+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.
59 60
 
60 61
 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.
61 62
 

+ 1
- 1
gulpfile.js View File

@@ -40,7 +40,7 @@ function styles() {
40 40
     var css_files = [
41 41
         './node_modules/codemirror/lib/codemirror.css',
42 42
         './src/css/*.css',
43
-        './node_modules/codemirror-spell-checker/src/css/spell-checker.css'
43
+        './node_modules/codemirror-spell-checker/src/css/spell-checker.css',
44 44
     ];
45 45
 
46 46
     return gulp.src(css_files)

Loading…
Cancel
Save