Skip to content

Commit e0a8e47

Browse files
authored
Update README.md
1 parent 561924a commit e0a8e47

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ In Go, variables declared without an explicit initial value are given their zero
1717

1818
## Marshalling/Unmarshalling JSON
1919

20+
**Note:** v0.6.0 introduces a potential breaking change to anyone depending on marshalling non-present values to their zero values instead of null. See: [#9](https://github.com/markphelps/optional/pull/9) for more context.
21+
2022
Option types also marshal to/from JSON as you would expect:
2123

2224
### Marshalling
@@ -165,3 +167,7 @@ See [example_test.go](example_test.go) and the [documentation](http://godoc.org/
165167
1. Commit your changes (`git commit -am 'Add some feature'`)
166168
1. Push to the branch (`git push origin my-new-feature`)
167169
1. Create a new Pull Request
170+
171+
### Golden Files
172+
173+
If changing the API you may need to update the [golden files](https://medium.com/soon-london/testing-with-golden-files-in-go-7fccc71c43d3) for your tests to pass by running `go test ./cmd/optional/... -update`.

0 commit comments

Comments
 (0)