rmagick 2.16.0 → 5.5.0

data/CHANGELOG.md

@@ -3,6 +3,542 @@
 All notable changes to this project are documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## RMagick 5.5.0
+
+Improvements
+
+- Add RBS signatures (#1458)
+- Remove unnecessary type check in KernelInfo#{unity_add, scale} (#1514)
+- Remove unnecessary type check in Image#{morphology, morphology_channel} (#1513)
+- Improve HatchFill.new to accept Pixel object as color (#1512)
+- Fix GraphicContext#font_weight to accept Numeric object (#1510)
+- Improve GraphicContext#font_weight to accept Symbol object (#1509)
+- Improve Stretchable#viewbox to use implicitly conversioned value (#1507)
+- Improve RVG::Transformable#rotate to convert to Float implicitly (#1506)
+- Fix Image#modulate in order to accept negative number (#1505)
+- Improve Image#modulate to accept "NN%" form string (#1504)
+- Implicit conversion to string with methods that expect a string (#1496)
+- Coerce to string instead of using #to_s (#1495)
+- Coerce to string where pass object into string interpolation (#1494)
+- Fix Draw#{fill_opacity, opacity, stroke_opacity} to correctly handle arguments (#1492)
+- Fix Draw#{interline_spacing, interword_spacing, kerning} to correctly handle arguments that can be converted to Float (#1491)
+- Remove unnecessary type check in KernelInfo methods (#1489)
+- Generate compile_flags.txt for clangd for development (#1488)
+- Fix Draw#{stroke_dasharray, stroke_miterlimit} to accept object which has #to_f method (#1486)
+- Fix Image#composite_affine to accept ImageList object (#1484)
+- Fix Image#add_compose_mask to accept ImageList object (#1483)
+- Fix incorrect number of required arguments in ArgumentError (#1482)
+- Fix ImageList#sort! that should return self (#1481)
+- Fix ImageList#eql? that should not raise exception if can't compare (#1479)
+- Fix ImageList#<=> that should return nil if can't compare (#1478)
+- Add DrawAttribute module to simplify Draw, DrawOptions and PolaroidOptions (#1477)
+- Add missing attribute writer methods in Image::{DrawOptions, PolaroidOptions} (#1476)
+- Add Image::PolaroidOptions#affine= (#1475)
+- Add Image::PolaroidOptions#tile= (#1474)
+- Attribute writer methods should return passed value (#1473)
+- Return self with ImageList if Image's method return self (#1472)
+- Fix Image#clut_channel to accept ImageList object (#1471)
+- Fix Magick::GradientFill#fill and Magick::TextureFill#fill to accept ImageList object (#1467)
+
+Bug Fixes
+
+- Fix typo in order to fix NoMethodError (#1515)
+- Sync compression value in order fix  the problem of compression being ignored by ImageMagick 7 (#1503)
+- Add PKG_CONFIG_PATH for ImageMagick 7 in order to fix installation error on macOS (#1501)
+
+## RMagick 5.4.4
+
+Bug Fixes
+
+- Fix installation error again in some environment at creatint Makefile (#1465)
+- Fix Pixel#<=> which should accept other class instance (#1463)
+
+## RMagick 5.4.3
+
+Bug Fixes
+
+- Fix installation error in some environment by using x flag to use C++ compiler in order to create Makefile (#1460)
+
+## RMagick 5.4.2
+
+Improvements
+
+- Check C++ compiler exists (#1453)
+
+## RMagick 5.4.1
+
+Bug Fixes
+
+- Fix invalid cast between different size variables (#1448)
+
+## RMagick 5.4.0
+
+Improvements
+
+- Use rb_io_path() if exist because pathv attr was marked as deprecated at Ruby 3.3 (#1409)
+- Add observer gem as dependency (#1411)
+- Add aliases of filter type (#1439)
+- Release GVL in Image#contrast (#1440)
+
+Bug Fixes
+
+- Use C++ compiler in order to fix installation error with latest ImageMagick 7 on Windows (#1433)
+
+## RMagick 5.3.0
+
+Improvements
+
+- Support GC compaction (#1388)
+
+Bug Fixes
+
+- Fix memory leak in `Magick::Draw` for recentry ImageMagick 6 by removing unnecessary `GetDrawInfo()` calling (#1406)
+- Fix crash on ImageList#write with animation gif (#1379)
+- Windows: Fix RubyInstaller::Runtime::DllDirectory::WinApiError (#1381)
+
+## RMagick 5.2.0
+
+Improvements
+
+- Add OnAlphaChannel and OffAlphaChannel to the AlphaChannelOption enumeration. (#1377)
+- Add Ruby 3.2 support (#1370)
+
+## RMagick 5.1.0
+
+Improvements
+
+- Improve multi-thread performance by releasing GVL (#1352)
+- Add Ractor support (#1349)
+- Avoid overriding compilation variables (#1365)
+- Remove pkg-config command dependency (#1366)
+
+## RMagick 5.0.0
+
+Improvements
+
+- Improve installer in order to avoid SEGV within pkg-config command (#1359)
+- Clean up the documents and comment in source code referring to something that no longer exist (#1363)
+- Remove deprecated 'tile' attribute in Draw#marshal_dump (#1364)
+- Remove deprecated #instance_eval calling when block was given with Magick::ImageList#montage, Magick::Image::Info.new and more (#1362)
+- Remove deprecated RMagick.rb file (#1361)
+- Remove deprecated Magick.trace_proc= (#1351)
+- Remove deprecated Magick::{Image, Image::Info}#monitor= (#1356)
+
+## RMagick 4.3.0
+
+Deprecates
+
+- Mark Magick.trace_proc= as deprecated (#1354)
+- Mark Magick::{Image, Image::Info}#monitor= as deprecated (#1353)
+
+These methods will be removed in RMagick 5.0 and no alternative.
+
+## RMagick 4.2.6
+
+Improvements
+
+- Remove test_files to reduce gem package size (#1338)
+
+Bug Fixes
+
+- Guard against an empty rpath (#1333)
+- Call GetImageDistortion instead of IsImagesEqual to fix the issue reported in #1342 (#1343)
+
+## RMagick 4.2.5
+
+Bug Fixes
+
+- Specify rpath linker option to fix dynamic lib lookup failure on Linux (#1325)
+- Fix Image#profile! that can't delete exif data (#1326)
+
+## RMagick 4.2.4
+
+Improvements
+
+- spec_helper: drop require_relative to lib directory (#1306)
+- Fix build error with Ruby 3.1 on macOS (#1313)
+
+Bug Fixes
+
+- remove Mutex in trace_proc= (#1303)
+- channel_mean_spec: fix floating point comparison (#1307)
+- changed_predicate_spec: ensure target directory exists (#1305)
+- Doc: Fix documentation of Magick::Image#crop (#1311)
+- Magick::UndefinedKernel should also not be used when creating a new KernelInfo. (#1312)
+
+## RMagick 4.2.3
+
+Bug Fixes
+
+- Re-add block syntax deprecation warning and fix in RMagick source (#1279) (#1280)
+- Doc: Replace Magick::Montage with Magick::ImageList::Montage (#1281)
+- Update shadow example (#1297)
+- Escape the backslashes in windows error message (#1298)
+- Also set the alpha value of the target pixel (#1299)
+- Set alpha_trait to BlendPixelTrait when the alpha value of the pixel is not opaque. (#1300)
+
+## RMagick 4.2.2
+
+Bug Fixes:
+
+- Remove deprecation warning about block syntax (#1272)
+
+You are still recommended to use the block parameter instead of `self.` but
+we're silencing the deprecation warning until we can get RMagick's code up to
+that standard.
+
+## RMagick 4.2.1
+
+Bug Fixes:
+
+- Fix compilation with optimization on glibc (#1263)
+
+## RMagick 4.2.0
+
+This adds a deprecation warning when using a block for image operations.
+Instead of setting properties on `self`, you should accept a block argument and
+modify that instead. In a future version we we no longer be binding the block
+to the image.
+
+```diff
+- img.to_blob { self.quality = 75 }
++ img.to_blob { |image| image.quality = 75 }
+```
+
+Improvements:
+
+- Updated error messages if runtime ImageMagick version was not matched with when installed rmagick (#1213)
+- Improve Image#resize performance with ImageMagick 7 (#1240)
+- Added new colorspaces (#1252)
+
+Bug Fixes:
+
+- Fix assertion failed in Magick::TextureFill.new with with unexpected argument (#1216)
+- Call with yield when there is a block arguments (#701)
+- Avoid crash with monitor feature on Ruby 3.0  (#1253)
+
+## RMagick 4.1.2
+
+Bug Fixes:
+
+- Fix build error on Freebsd (#1199)
+- Add workaround for FreeBSD that it isn't able to process PDF (#1203)
+
+## RMagick 4.1.1
+
+Bug Fixes:
+
+- Fix bug of signal handling internally (#1189)
+
+## RMagick 4.1.0
+
+Improvements:
+
+- reduce package size by more than 1.5mb (#849)
+- improve memory usage (#836)
+- add support for Ruby 2.7 (#853)
+- *many* documentation fixes and cleanups
+- *many* testing fixes and cleanups
+- Support CMYK color in Image#get_pixels (#871)
+- Support to get CMYK color in Image#pixel_color (#875)
+- Support to set CMYK color in Image#pixel_color (#908)
+- Add ImageList#map (#1154)
+
+Bug Fixes:
+
+- fixed memory leaks (#809, #815, #816, #960, #1024)
+- eliminate compiler warnings (#855, #864, #878, #917, #969, #981, #996, #1000, #1044)
+- Recognize invert option in Image#opaque_channel with ImageMagick 7 (#882)
+- Fix heap-buffer-overflow in Image#wet_floor with ImageMagick 7 (#883)
+- Handle channel value with new image in Image#opaque_channel with ImageMagick 7 (#886)
+- Pass caption value into ImageMagick 7 API in Image#polaroid (#898)
+- Example: Fix “uninitialized constant Magick::TransparentOpacity” error (#899)
+- Example: Fix error of constant usage (#900)
+- Example: Fix error in doc/ex/composite.rb (#901)
+- Example: Fix error in doc/ex/crop_with_gravity.rb (#902)
+- Revert removed RemapImages() calling in ImageList#remap for ImageMagick 6 (#904)
+- Example: Fix alpha channel in examples/vignette.rb (#918)
+- Example: Fix alpha channel in doc/ex/coalesce.rb (#920)
+- Handle alpha value in Pixel#to_color (#922)
+- Detect the proper ARCHFLAGS on macOS (#923)
+- Handle boolean value as dither option in ImageList#quantize (#926)
+- Use strlcpy instead of strncpy to ensure null terminating. (#933)
+- Remove memalign() (#939)
+- Add safe strlen() to ensure avoiding buffer overrun (#940)
+- Use strlcpy() instead of strcpy() to ensure avoiding buffer overflow (#941)
+- Use snprintf() instead of sprintf() to ensure avoiding buffer overflow (#945)
+- Example: Remove unnecessary alpha setting (#950)
+- Replace to correct format specifiers for size_t/ssize_t value (#978)
+- Use proper format specifiers within MinGW (#997)
+- Fix snprintf() format specifiers for unsigned value (#1006)
+- Fix warning of “Variable is reassigned a value before the old one has been use” (#1008)
+- Fix warning of “warning: explicitly assigning value of variable of type 'int' to itself” (#1013)
+- Fix Image#resample to use blur option properly with ImageMagick 7 (#1023)
+- Fix Image#resize to use blur option properly with ImageMagick 7 (#1032)
+- Fix that Color#compliance returns nil with undefined bit (#1049)
+- Check memory API properly on Windows (#1050)
+- Example: Fix “undefined method `opacity’” (#1051)
+- Add workaround to pdf problem (#1072)
+- Fix exception message because #export_pixels accept 0 argument (#1121)
+- Fix default value of `fill` argument in Image#initialize (#1122)
+- Call rm_ensure_result() in creating Image object (#1144)
+- Use StringValueCStr() instead of StringValuePtr() (#1156)
+- Use RSTRING_PTR() to retrieve a pointer of String object for buffer (#1157)
+- Use StringValueCStr() to get null-terminated C-lang string (#1158)
+- Fix SEGV in Magick::Draw#marshal_load (#1162)
+- Fix SEGV in rm_check_ary_len() with unexpected argument value (#1168)
+- Fix SEGV in Image#marshal_load (#1169)
+
+Breaking Changes:
+
+- remove `tainted?` logic (#854)
+
+## RMagick 4.1.0.rc2
+
+- fix a couple of compilation bugs (#796, #797)
+
+## RMagick 4.1.0.rc1
+
+The ImageMagick 7 release is here! This adds beta support for ImageMagick 7.
+Much thanks to **@Watson1978** for getting the ball rolling on this and to
+**@dlemstra** for the extraordinary amount of work and patience that went into
+seeing it through. RMagick should currently behave the same way under IM7 as it
+did under IM6, so please open an issue if you find anything that seems out of
+the ordinary.
+
+## RMagick 4.0.0
+
+This release removes a *lot* of deprecated functionality, so first upgrade to
+3.2 and handle any deprecation warnings you see there before upgrading to 4.0.
+There are a handful of removals that we could not, or forgot to deprecate, so
+pay special attention to those below. This clears the road for ImageMagick 7
+support in the very near future.
+
+Breaking Changes:
+
+- Removed deprecated Image#matte and Image#matte= (#731)
+- Removed deprecated Draw#matte. (#736)
+- Removed deprecated ImageList#fx. (#732)
+- Removed deprecated Info#group and Info#group=. (#733)
+- Removed deprecated KernelInfo#show. (#734)
+- Removed deprecated Pixel#opacity and Pixel#opacity=. (#735)
+- Removed deprecated KernelInfo#zero_nans. (#741)
+- Removed deprecated ImageList#map (#740)
+- Removed deprecated Pixel#from_HSL. (#742)
+- Removed deprecated Image#alpha=. (#739)
+- Removed deprecated Pixel#to_HSL. (#745)
+- Removed deprecated Image#blur and Image#blur=. (#746)
+- Removed deprecated Image#sync_profiles. (#754)
+- Removed deprecated Image#opacity=. (#753)
+- Removed deprecated Image#combine. (#752)
+- Removed deprecated Image#map. (#751)
+- Removed deprecated Image#mask=. (#750)
+- Removed deprecated opacity arguments. (#757)
+- Removed deprecated `OpaqueOpacity` and `TransparentOpacity`. (#765)
+- Removed obsolete enumerations. (#766)
+
+The following changes *did not have deprecation warnings* in 3.2, so you'll
+want to double check that you update your code if you were relying on the
+existing behavior:
+
+- Changed Color#to_s to return an string that contains alpha instead of opacity. (#760)
+- Changed Pixel#to_s to return a string that contains alpha instead of opacity. (#762)
+- Changed Pixel#hash to use alpha instead of opacity. (#763)
+- Changed Pixel#<=> to use alpha instead of opacity. (#764)
+- Removed `BicubicInterpolatePixel` (use `CatromInterpolatePixel` instead) (#768)
+- Removed `FilterInterpolatePixel` (no replacement) (#768)
+- Renamed `NearestNeighborInterpolatePixel` to `NearestInterpolatePixel` (#768)
+
+Enhancements:
+
+- Add SetQuantumOperator (#755)
+
+Bug Fixes:
+
+- Fix SEGV in Image#each_profile (#737)
+
+## RMagick 3.2.0
+
+This is expected to be the final deprecation release before RMagick 4.0. We
+have added loads of deprecation warnings to clear the pathway for ImageMagick 7
+support. Once you've fixed all of them you should be fine to upgrade to version
+4.0 without any pain. There are a small handful of edge cases which we could
+not cleanly deprecate, though they should be extremely rare. These will be
+documented in the 4.0 release. Thanks to @dlemstra for the hard work making
+this release possible.
+
+The biggest change in moving towards RMagick 4.0 will be the fact that
+`opacity` is deprecated in favor of `alpha`.
+
+**NOTE: `opacity` is the opposite of `alpha`!!!**
+
+If you are currently passing opacity into methods, you will need to invert the
+value and use the new `alpha:` keyword argument. If you are passing an integer,
+`alpha = 255 - opacity`. An integer `opacity` of 0 is an `alpha` of 255.
+
+Also, **major kudos to @Watson1978** for enabling Ruby's memory management in
+(#697).  This should go a long way towards improving RMagick's reputation for
+memory usage.
+
+Deprecations: (To be removed in RMagick 4.0)
+
+- `Info#group` (#578) (no replacement)
+- `Image#blur` (#579) (no replacement)
+- Renamed `AlphaChannelType` to `AlphaChannelOption` (#596)
+- Renamed `DistortImageMethod` to `DistortMethod` (#605)
+- Renamed `FilterTypes` to `FilterType` (#611)
+- Renamed `InterpolatePixelMethod` to `PixelInterpolateMethod` (#613)
+- Renamed `ImageLayerMethod` to `LayerMethod` (#618)
+- Deprecate the `opacity` property of the Pixel class. (use `alpha` instead) (#619)
+- Deprecate old enum names. (use IM7 names instead) (#627)
+- `StaticGravity` (use `CenterGravity` instead) (#638)
+- `Image#sync_profiles` (no replacement) (#640)
+- Deprecate old metric type values (use IM7 names instead) (#647)
+- Deprecate `ResetAlphaChannel` (no replacement) (#644)
+- Deprecate `FlattenAlphaChannel` (no replacement) (#645)
+- Deprecate `MatteChannel` (no replacement) (#646)
+- Deprecate `ConstantVirtualPixelMethod` (no replacement) (#649)
+- Deprecate `IntegerPixel` (no replacement) (#650)
+- Deprecate `Image.combine` (use `ImageList#combine` instead) (#690)
+- Deprecate `Image#opacity` (use `Image#alpha` instead) (#669)
+- Deprecate unnamed argument for opacity in `Image#transparent` (use keyword `alpha:` instead) (#695)
+- Deprecate unnamed argument for opacity in `Image#black_threshold` and `Image#white_threshold.` (use keyword `alpha:` instead) (#709)
+- Deprecate unnamed argument for opacity in `Image#matte_flood_fill` (use keyword `alpha:` instead) (#711)
+- Deprecate unnamed argument for opacity in `Image#paint_transparent` (use keyword `alpha:` instead) (#717)
+- Deprecate unnamed argument for opacity in `Image#transparent_chroma.` (use keyword `alpha:` instead) (#722)
+- Deprecate `Draw#matte` (use `Draw#alpha` instead) (#724)
+
+Enhancements:
+
+- Many internal adjustments to prepare for ImageMagick 7 support.
+- Added alpha property to the pixel class. (#617)
+- Add combine to the ImageList class. (#589)
+- Add new alpha constants (#651)
+- Add `Image#mask=` (#660)
+- Add `Draw#alpha` to replace `Draw#matte` (#726)
+- Add Draw#image (#720)
+- Add ArchLinux support (#727)
+
+Bug Fixes:
+
+- Fix `Font#to_s` to not raise error (#569)
+- Fix a SEGV in `Image#reduce_noise` (#576)
+- Fix infinite loop in `Image#compose` (#587)
+- Fix enumeration memory leaks (#592) (#594) (#606) (#610) (#626)
+- Don't allow `Image#class_type` to be set to undefined (#599)
+- Fixed setting the name of the clip path. (#608)
+- Fix memory leak in `Info#view=` (#642)
+- Fix memory leak in `Image.constitute` (#665)
+- Raise error on invalid arguments in `Draw#bezier` (#674)
+- Fix memory leak in `Image#sparse_color` (#683)
+- Prevent negative values for `Image#convolve` (#679)
+- Several cleanups and fixes in the examples
+- Raise error on invalid arguments in `Draw#color` (#691)
+- Raise error on invalid arguments in `Draw#opacity` (#692)
+- Raise error on invalid arguments in `Draw#fill_opacity` (#693)
+- Raise error on invalid arguments in `Draw#stroke_opacity` (#694)
+- Raise error on invalid arguments in `Draw#font_weight` (#696)
+- Raise error on invalid arguments in `Draw#pattern` (#702)
+- Raise error on invalid arguments in `Draw#point` (#703)
+- Raise error on invalid arguments in `Draw#font_size` (#704)
+- Raise error on invalid arguments in `Draw#polygon` (#705)
+- Raise error on invalid arguments in `Draw#polyline` (#706)
+- Raise error on invalid arguments in `Draw#rotate` (#707)
+- Raise error on invalid arguments in `Draw#scale` (#708)
+- Raise error on invalid arguments in `Draw#stroke_dashoffset` (#710)
+- Raise error on invalid arguments in `Draw#translate` (#713)
+- Raise error on invalid arguments in `Draw#text` (#714)
+- Raise error on invalid arguments in `Draw#stroke` (#715)
+- Raise error on invalid arguments in `Draw#matte` (#716)
+- Raise error on invalid arguments in `Draw#skewx`, `Draw#skewy` (#719)
+- Fix `Image#thumbnail` to keep image aspect ratio like ImageMagick (#718)
+- Fix bug where `ImageList#montage` doesn't apply `border_color` & `matte_color` (#601)
+- Fix stack-buffer-overflow in `Draw#annotate` (#725)
+- Enable managed memory feature (#697)
+
+Code Quality:
+
+- Many tests written
+- Several fixes to reduce compiler warnings.
+
+## RMagick 3.1.0
+
+Deprecations: (To be removed in RMagick 4.0)
+
+- Support for Ruby 2.3
+- `KernelInfo#zero_nans` (#531) (no replacement)
+- `KernelInfo#show` (#532) (no replacement)
+- `ImageList#fx` (#529) (use `Image#fx` instead)
+- `Image#alpha=` (#530) (use `Image#alpha` instead)
+- `Image#mask=` (#530) (use `Image#mask` instead)
+- `Image#matte` (#530) (use `Image#alpha` instead)
+- `Image#matte=` (#530) (use `Image#alpha` instead)
+
+Enhancements:
+
+- Support ruby-mswin environment on Windows (#425)
+- Add test for supporting webp format (#406)
+- Add explicit Ruby 2.5 support (#339)
+- Add explicit Ruby 2.6 support (#467)
+- Restore support for ImageMagick 6.7 (#475)
+- Add explicit ImageMagick 6.9 support (#340)
+- Work towards ImageMagick 7.0 support (#470) (#487) (#489) (#492) (#494)
+- Improve error messaging (#480) (#517)
+- Add TimeResource support (#402)
+- Add Image#fx method (#529)
+
+Bug Fixes:
+
+- Many, many memory leaks fixed
+  (#362) (#361) (#360) (#359) (#358) (#357) (#367) (#370) (#364) (#372) (#373)
+  (#374) (#375) (#376) (#385) (#384) (#383) (#382) (#381) (#380) (#379) (#378)
+  (#377) (#391) (#390) (#389) (#396) (#401) (#409) (#419) (#417) (#416) (#415)
+  (#414) (#413) (#412) (#411) (#410) (#418) (#454) (#453) (#452) (#451) (#450)
+  (#461) (#460) (#459) (#563)
+- Fix SEGV in ImageList methods with invalid image list (#356)
+- Fix SEGV in Image#recolor (#387)
+- Fix SEGV in Image#profile! (#400)
+- Fix build error on Homebrew environment (#426)
+- Fix Image#quantize and ImageList#quantize could not make dither false (#458)
+- Replace obsoleted $defout to $stdout (#463)
+- Avoid SEGV in monitor feature for Ruby 2.5+ (#462)
+- Fix SEGV in Image#write with CMYKColorspace (#465)
+- Avoid problems related to GC in monitor feature (#468)
+- Get rid of compiler warnings (#484) (#491) (#500)
+- Fix rmfill leaks (#528)
+- Removed automatic allocation of the ImageInfo that is broken. (#547)
+- Fix color histogram (#540)
+- Fix Image#iptc_profile does not work with ImageMagick 6.7 (#558)
+
+Code Quality:
+
+- Many tests written
+- CI improvements
+- Other refactors
+
+## RMagick 3.0.0
+
+Breaking Changes:
+
+- Drop support for Ruby < 2.3.
+- Drop support for ImageMagick < 6.8.
+- Raise error when `nil` or empty string are passed to `Image.read`. (#351)
+- Monitor feature disabled on Windows. (#344)
+- Note: ruby versions > 2.4 and ImageMagick versions > 6.8 are not *explicitly*
+  supported, yet, but if you are using them already, they should continue to
+  work in the same fashion.
+
+Enhancements:
+
+- Add feature `Image#channel_entropy` (#300)
+- Many quality of life improvements in the codebase.
+
+Bug Fixes:
+
+- Many memory leaks fixed!
+- Fix `LoadError` on Windows. (#315)
+- fix argument count in `Image#morphology_channel` (#306)
+
 ## RMagick 2.16.0
 
 - Support ImageMagick 6.9+ - @ZipoKing

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,128 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+## Our Standards
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-*This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)*
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+robert@boon.gl. All complaints will be reviewed and investigated promptly and
+fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.