Skip to content

Commit 65cef56

Browse files
committed
Add CHANGELOG.md, update CONTRIBUTING.md and fix typo in README.md
1 parent 175afef commit 65cef56

File tree

3 files changed

+22
-10
lines changed

3 files changed

+22
-10
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
### Added
10+
- Merged PR #34 `::async-flow-fx/notify` NOP event handler for minimal flow signals. See ["Event Messaging" in README.md](https://github.com/day8/re-frame-async-flow-fx#event-messaging)

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,17 @@ karma start # to run the tests with an auto watcher
4545

4646
If possible provide:
4747

48-
* Code that fixes the bug
49-
* Failing tests which pass with the new changes
50-
* Improvements to documentation to make it less likely that others will run into issues (if relevant).
48+
- Code that fixes the bug.
49+
- Failing tests which pass with the new changes.
50+
- Improvements to documentation to make it less likely that others will run into issues (if relevant).
51+
- Add the change to the Unreleased section of [CHANGELOG.md](CHANGELOG.md)
5152

5253
## Pull requests for features
5354

5455
If possible provide:
5556

56-
* Code that implements the new feature
57-
* Tests to cover the new feature including all of the code paths
58-
* Docstrings for functions
59-
* Documentation examples
57+
- Code that implements the new feature
58+
- Tests to cover the new feature including all of the code paths
59+
- Docstrings for functions
60+
- Documentation examples
61+
- Add the change to the Unreleased section of [CHANGELOG.md](CHANGELOG.md)

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -433,17 +433,17 @@ Or, to dispatch a server error event if a status of 500 or above has been seen
433433
In an async flow it is often useful to dispatch an event to indicate success or failure of
434434
some process. However, this event may not actually have to do anything. `re-frame` will issue a
435435
warning if an event is dispatched that has not been registered by `reg-event-db` or `reg-event-fx`.
436-
If you use this pattern alot it quickly becomes inconvienent to register multiple no-op handlers to
436+
If you use this pattern a lot it quickly becomes inconvenient to register multiple no-op handlers to
437437
avoid this warning.
438438

439439
To address this issue we provide a no-op handler `::async-flow-fx/notify` which you can use in the
440440
following way.
441441

442442
```clj
443-
[{:when :seen? :events [[::async-flow-fx/notify :success-db-connect]]
443+
[{:when :seen? :events [[::async-flow-fx/notify :success-db-connect]]
444444
:dispatch-n '([:do-query-user] [:do-query-site-prefs])}
445445
...]}]
446-
```
446+
```
447447

448448
Note `::async-flow-fx/notify` doesn't do anything special and if you like you can add your own
449449
no-op event.

0 commit comments

Comments
 (0)