Add a Changelog

CHANGELOG.md

@@ -0,0 +1,159 @@
+# Changelog
+
+## [Unreleased]
+
+### Highlights
+
+#### Basic X11 backend for druid-shell. ([#599])
+
+[@crsaracco] has implemented basic support to run druid on bare-metal X11!
+
+While still incomplete this lays the foundation for running druid on Linux without relying on GTK.
+
+#### Mostly complete Wasm backend for druid-shell. ([#759])
+
+[@elrnv] continued the work of [@tedsta] and implemented a mostly complete Wasm backend and enabled all druid examples to [run in the browser](https://elrnv.github.io/druid-wasm-examples/).
+
+While some features like the clipboard, menus or file dialogs are not yet available, all fundamental features are there.
+
+### Added
+
+- `TextBox` can receive `EditAction` commands. ([#814] by [@cmyr])
+- `Split::min_splitter_area(f64)` to add padding around the splitter bar. ([#738] by [@xStrom])
+- Published `druid::text` module. ([#816] by [@cmyr])
+- `InternalEvent::MouseLeave` signalling the cursor left the window. ([#821] by [@teddemunnik])
+- `children_changed` now always includes layout and paint request. ([#839] by [@xStrom])
+- `UpdateCtx::submit_command`. ([#855] by [@cmyr])
+- `request_paint_rect` for partial invalidation. ([#817] by [@jneem])
+- Window title can be any `LabelText` (such as a simple `String`). ([#869] by [@cmyr])
+- `Label::with_font` and `set_font`. ([#785] by [@thecodewarrior])
+- `InternalEvent::RouteTimer` to route timer events. ([#831] by [@sjoshid])
+
+### Changed
+
+- Renamed `Split` constructors to `Split::rows` and `columns`. ([#738] by [@xStrom])
+- `Split::splitter_size` no longer includes padding. ([#738] by [@xStrom])
+- Renamed `Event::MouseMoved` to `MouseMove`. ([#825] by [@teddemunnik])
+- `has_focus` no longer returns false positives. ([#819] by [@xStrom])
+- `Event::Internal(InternalEvent)` bundles all internal events. ([#833] by [@xStrom])
+- `WidgetPod::set_layout_rect` now requires `LayoutCtx`, data and `Env`. ([#841] by [@xStrom])
+- `request_timer` uses `Duration` instead of `Instant`. ([#847] by [@finnerale])
+- Global `Application` associated functions are instance methods instead, e.g. `Application::global().quit()` instead of the old `Application::quit()`. ([#763] by [@xStrom])
+- Timer events will only be delivered to the widgets that requested them. ([#831] by [@sjoshid])
+
+### Deprecated
+
+- Nothing
+
+### Removed
+
+- The optional GTK feature for non-Linux platforms. ([#611] by [@pyroxymat])
+
+### Fixed
+
+- GTK: Use the system locale. ([#798] by [@finnerale])
+- GTK: Actually close windows ([#797] by [@finnerale])
+- Windows: Respect the minimum window size. ([#727] by [@teddemunnik])
+- Windows: Respect resizability. ([#712] by [@teddemunnik])
+- `Event::HotChanged(false)` will be emitted when the cursor leaves the window. ([#821] by [@teddemunnik])
+- Windows: Capture mouse for drag actions. ([#695] by [@teddemunnik])
+- Start focus cycling from non-registered-for-focus widgets. ([#819] by [@xStrom])
+- Propagate `Event::FocusChanged` to focus gaining widgets as well. ([#819] by [@xStrom])
+- GTK: Prevent crashing on pop-ups. ([#837] by [@finnerale])
+- Keep hot state consistent with mouse position. ([#841] by [@xStrom])
+- Open file menu item works again. ([#851] by [@kindlychung])
+- Supply correct `LifeCycleCtx` to `Event::FocusChanged`. ([#878] by [@cmyr])
+- Windows: Termiate app when all windows have closed. ([#763] by [@xStrom])
+- macOS: `Application::quit` now quits the run loop instead of killing the process. ([#763] by [@xStrom])
+
+### Visual
+
+- Improved `Split` accuracy. ([#738] by [@xStrom])
+- Built-in widgets no longer stroke outside their `paint_rect`. ([#861] by [@jneem])
+
+### Docs
+
+- Reduce the flashing in ext_event and identity examples. ([#782] by [@futurepaul])
+- Added example and usage hints to `Env`. ([#796] by [@finnerale])
+- Added documentation about the usage of bloom filters. ([#818] by [@xStrom])
+- Added Book chapters about `Painter` and `Controller`. ([#832] by [@cmyr])
+- Added hot glow option to multiwin example. ([#845] by [@xStrom])
+- Added new example for blocking functions. ([#840] by [@mastfissh])
+- Added a changelog containing development since the 0.5 release. ([#889] by [@finnerale])
+
+### Maintenance
+
+- Replaced `#[macro_use]` with normal `use`. ([#808] by [@totsteps])
+- Enabled Clippy checks for all targets. ([#850] by [@xStrom])
+- Added rendering tests. ([#784] by [@fishrockz])
+- Revamped CI testing to optimize coverage and speed. ([#857] by [@xStrom])
+
+### Outside News
+
+- There are two new projects using druid:
+  - [Kondo](https://github.com/tbillington/kondo) Save disk space by cleaning unneeded files from software projects.
+  - [jack-mixer](https://github.com/derekdreery/jack-mixer) A jack client that provides mixing, levels and a 3-band eq.
+
+[#599]: https://github.com/xi-editor/druid/pull/599
+[#611]: https://github.com/xi-editor/druid/pull/611
+[#695]: https://github.com/xi-editor/druid/pull/695
+[#712]: https://github.com/xi-editor/druid/pull/712
+[#727]: https://github.com/xi-editor/druid/pull/727
+[#738]: https://github.com/xi-editor/druid/pull/738
+[#759]: https://github.com/xi-editor/druid/pull/759
+[#763]: https://github.com/xi-editor/druid/pull/763
+[#782]: https://github.com/xi-editor/druid/pull/782
+[#784]: https://github.com/xi-editor/druid/pull/784
+[#785]: https://github.com/xi-editor/druid/pull/785
+[#796]: https://github.com/xi-editor/druid/pull/796
+[#797]: https://github.com/xi-editor/druid/pull/797
+[#798]: https://github.com/xi-editor/druid/pull/798
+[#808]: https://github.com/xi-editor/druid/pull/808
+[#814]: https://github.com/xi-editor/druid/pull/814
+[#816]: https://github.com/xi-editor/druid/pull/816
+[#817]: https://github.com/xi-editor/druid/pull/817
+[#818]: https://github.com/xi-editor/druid/pull/818
+[#819]: https://github.com/xi-editor/druid/pull/819
+[#821]: https://github.com/xi-editor/druid/pull/821
+[#825]: https://github.com/xi-editor/druid/pull/825
+[#831]: https://github.com/xi-editor/druid/pull/831
+[#832]: https://github.com/xi-editor/druid/pull/832
+[#833]: https://github.com/xi-editor/druid/pull/833
+[#837]: https://github.com/xi-editor/druid/pull/837
+[#839]: https://github.com/xi-editor/druid/pull/839
+[#840]: https://github.com/xi-editor/druid/pull/840
+[#841]: https://github.com/xi-editor/druid/pull/841
+[#845]: https://github.com/xi-editor/druid/pull/845
+[#847]: https://github.com/xi-editor/druid/pull/847
+[#850]: https://github.com/xi-editor/druid/pull/850
+[#851]: https://github.com/xi-editor/druid/pull/851
+[#855]: https://github.com/xi-editor/druid/pull/855
+[#857]: https://github.com/xi-editor/druid/pull/857
+[#861]: https://github.com/xi-editor/druid/pull/861
+[#869]: https://github.com/xi-editor/druid/pull/869
+[#878]: https://github.com/xi-editor/druid/pull/878
+[#889]: https://github.com/xi-editor/druid/pull/899
+
+## [0.5] - 2020-04-01
+
+Last release without a changelog :(
+
+[@futurepaul]: https://github.com/futurepaul
+[@finnerale]: https://github.com/finnerale
+[@totsteps]: https://github.com/totsteps
+[@cmyr]: https://github.com/cmyr
+[@xStrom]: https://github.com/xStrom
+[@teddemunnik]: https://github.com/teddemunnik
+[@crsaracco]: https://github.com/crsaracco
+[@pyroxymat]: https://github.com/pyroxymat
+[@elrnv]: https://github.com/elrnv
+[@tedsta]: https://github.com/tedsta
+[@kindlychung]: https://github.com/kindlychung
+[@jneem]: https://github.com/jneem
+[@fishrockz]: https://github.com/fishrockz
+[@thecodewarrior]: https://github.com/thecodewarrior
+[@sjoshid]: https://github.com/sjoshid
+[@mastfissh]: https://github.com/mastfissh
+
+[Unreleased]: https://github.com/xi-editor/druid/compare/v0.5.0...master
+[0.5]: https://github.com/xi-editor/druid/compare/v0.4.0...v0.5.0

CONTRIBUTING.md

@@ -9,8 +9,15 @@ All submissions, including submissions by project members, require review. We
 use GitHub pull requests for this purpose. Consult [GitHub Help] for more
 information on using pull requests.
 
+Every pull request should document all changes made in the [changelog].
+- The format is always `- [what changed]. ([#pr-number] by [@username])`.
+- The number can be guessed or added after creating the pull request.
+- Links to all pull requests are recorded at the bottom of the unreleased section.
+- If you are a new contributor, please add your name to the others at the bottom of the CHANGELOG.md.
+
 If your name does not already appear in the [AUTHORS] file, please feel free to
 add it as part of your patch.
 
 [GitHub Help]: https://help.github.com/articles/about-pull-requests/
 [AUTHORS]: AUTHORS
+[changelog]: CHANGELOG.md

README.md

@@ -15,7 +15,8 @@ Druid's current development is largely driven by its use in [Runebender], a new
 font editor.
 
 We have been doing periodic releases of druid on crates.io, but it is under
-active development and its API might change.
+active development and its API might change. All changes are documented
+in [the changelog](https://github.com/xi-editor/druid/blob/master/CHANGELOG.md).
 
 For an overview of some key concepts, see the (work in progress) [druid book].