diff-lcs 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3538bd306feb87c5a2d957b3956a9b8ede2a2782db387f9f253115053c2066a1
-  data.tar.gz: af8dd06512d39de79534212726c6ed9beba9560e110a1026666181a21dbb5dcb
+  metadata.gz: 5809a8a19bbbf227168d81fa0dcfe681aff17a494b16cd6af723f7dd665ed0d0
+  data.tar.gz: 844c07fe8cdc69183f0c0bb8f16cdfadae58d099eb3ab5927ac2aa9b50133948
 SHA512:
-  metadata.gz: 3598cd0dc37b22112495d82949a3d846751ca2dc3717dffe313acf6740761df98ed6d9f158ebc1fc7be6739bb3ac774ee3d8a0c4ccb4f2f651aaa5c45b49e9d9
-  data.tar.gz: 77f4c9705752143e88953395b991d4105de3e744f524421ff9a3933aa18febf82854462835ede955b72c62884143f27b9278f968f4629f40bbce2192ca44aa5b
+  metadata.gz: 219465ac1abcd2636a39e4425a0a84d64759b6818fa7b885ebfdd941af52344658568b52485c343e74b6dab7a300cf2109a38094ff94aca3f51bef31a3e13987
+  data.tar.gz: '082bd353ec1fb53cb848a435162ed9dd152f526cab697353de8fd8b9b319fdd319d90a7b1ec45f1259f2cf525fe81aba88f892c43712ff92d09da411391ace76'

data/CHANGELOG.md

@@ -0,0 +1,491 @@
+# Changelog
+
+## 1.6.0 / 2025-02-13
+
+- Baptiste Courtois (@annih) has done significant work on making `bin/ldiff`
+  work better, contributing a number of issues and pull requests. These include:
+
+  - Separation of command parsing from diff-generation in `Diff::LCS::Ldiff`
+    code extraction making it easier to use separately from the `bin/ldiff`
+    command in [#103][pull-103]. This partially resolves [#46][issue-46].
+
+  - Improvement of binary and empty file detection and tests in [#104][pull-104]
+    and [#105][pull-105]. This resolves issues [#100][issue-100],
+    [#102][issue-102].
+
+  - Various ldiff fixes for output [#101][pull-101] resolves issues
+    [#106][issue-106] (ldiff ed scripts are inverted), [#107][issue-107] (ldiff
+    hunk ranges are incorrect; regression or incorrect fix for [#60][issue-60]),
+    and [#95][issue-95].
+
+- Patrick Linnane fixed various minor typos. [#93][pull-93]
+
+- Mark Young added a Changelog link to the RubyGems metadata. [#92][pull-92]
+  This has been modified to incorporate it into the README.
+
+- Updated the documentation on `Diff::LCS#lcs` to be clearer about the
+  requirements for object equality comparison. This resolves [#70][issue-70].
+
+- Governance:
+
+  Changes described here are effective 2024-12-31.
+
+  - Update gem management details to use markdown files for everything, enabled
+    in part by [flavorjones/hoe-markdown][hoe-markdown]. Several files were
+    renamed to be more consistent with standard practices.
+
+  - Updated security notes with an [age][age] public key rather than pointing to
+    Keybase.io and a PGP public key which I no longer use. The use of the
+    [Tidelift security contact][tidelift] is recommended over direct disclosure.
+
+## 1.5.1 / 2024-01-31
+
+- Peter Goldstein updated CI configuration to add Ruby 3.1 and Masato Nakamura
+  added Ruby 3.2 and 3.3. [#82][pull-82], [#89][pull-89]
+
+- Switched to [standard ruby][standard ruby] formatting.
+
+- Justin Steele converted the licence file to Markdown. [#84][pull-84]
+
+- Updated the gem SPDX identifier for GPL 2.0 or later, resolving [#86][pull-86]
+  by Vit Ondruch.
+
+- Resolve a potential security issue with `ldiff` in its use of `IO.read`
+  instead of `File.read`. [#91][issue-91]
+
+- Added MFA authentication requirement for release to RubyGems. [#90][pull-90]
+
+- Added Dependabot management for actions and gems. [#90][pull-90]
+
+- Updated CodeQL configuration. [#90][pull-90]
+
+## 1.5.0 / 2021-12-23
+
+- Updated the CI configuration and monkey-patch Hoe.
+
+- Kenichi Kamiya fixed a test configuration deprecation in SimpleCov.
+  [#69][pull-69]
+
+- Tien introduced several corrections and code improvements:
+
+  - Removed an off-by-one error when calculating an index value by embracing
+    Ruby iteration properly. This had a side-effect of fixing a long-standing
+    bug in `#traverse_sequences` where the traversal would not be transitive.
+    That is, `LCS(s2, s1)` should produce a sequence that is transitive with
+    `LCS(s1, s2)` on traversal, and applying the diff computed from those
+    results would result in equivalent changes that could be played forward or
+    backward as appropriate. [#71][pull-71], [#75][pull-75]
+
+  - The above fix resulted in a changed order of the longest common subsequence
+    when callbacks were applied. After analysis, it was determined that the
+    computed subsequence was _equivalent_ to the prior version, so the test was
+    updated. This also resulted in the clarification of documentation when
+    traversing the sub-sequences. [#79][pull-79]
+
+  - An infinite loop case in the case where `Diff::LCS` would be included into
+    an enumerable class has been fixed. [#73][pull-73]
+
+  - Clarified the purpose of a threshold test in calculation of LCS.
+    [#72][pull-72], [#80][pull-80]
+
+- Removed autotest directory
+
+## 1.4.4 / 2020-07-01
+
+- Fixed an issue reported by Jun Aruga in the `Diff::LCS::Ldiff` binary text
+  detection. [#44][issue-44]
+
+- Fixed a theoretical issue reported by Jun Aruga in `Diff::LCS::Hunk` to raise
+  a more useful exception. [#43][issue-43]
+
+- Added documentation that should address custom object issues as reported in
+  [#35][issue-35].
+
+- Fixed more diff errors, in part reported in [#65][issue-65].
+
+  - The use of `Numeric#abs` is incorrect in `Diff::LCS::Block#diff_size`. The
+    diff size _must_ be accurate for correct change placement.
+
+  - When selecting `@max_diff_size` in `Diff::LCS::Hunk`, choose it based on
+    `block.diff_size.abs`.
+
+  - Made a number of changes that will, unfortunately, increase allocations at
+    the cost of being safe with frozen strings.
+
+  - Add some knowledge that when `Diff::LCS::Hunk#diff` is called, that we are
+    processing the _last_ hunk, so some changes will be made to how the output
+    is generated.
+
+    - `old`, `ed`, and `reverse_ed` formats have no differences.
+
+    - `unified` format will report `` given the
+      correct conditions, at most once. Unified range reporting also differs for
+      the last hunk such that the `length` of the range is reduced by one.
+
+    - `context` format will report `\No newline at end of file` given the
+      correct conditions, up to once per "file". Context range reporting also
+      differs for the last hunk such that the `end` part of the range is reduced
+      by one to a minimum of one.
+
+- Added a bunch more tests for the cases above, and fixed `hunk_spec.rb` so that
+  the phrase being compared isn't nonsense French.
+
+- Updated formatting.
+
+- Added a Rake task to assist with manual testing on Ruby 1.8.
+
+## 1.4.3 / 2020-06-29
+
+- Fixed several issues with 1.4 on Rubies older than 2.0. Some of this was
+  providing useful shim functions to Hoe 3.x (which dropped these older Rubies a
+  while ago). Specifically:
+
+  - Removed Array#lazy from a method in `Diff::LCS::Hunk`.
+
+  - Changed some unit tests to use old-style Symbol-keyed hashes.
+
+  - Changed some unit test helper functions to no longer use keyword parameters,
+    but only a trailing options hash.
+
+  - Made the use of `psych` dependent on `RUBY_VERSION >= 1.9`.
+
+  Resolves [#63][issue-63].
+
+## 1.4.2 / 2020-06-23
+
+- Camille Drapier fixed a small issue with RuboCop configuration. [#59][pull-59]
+
+- Applied another fix (and unit test) to fix an issue for the Chef team.
+  [#60][issue-60], [#61][pull-61]
+
+## 1.4.1 / 2020-06-23
+
+- Fix an issue where diff sizes could be negative, and they should be.
+  [#57][issue-57], [#58][pull-58]
+
+## 1.4 / 2020-06-23
+
+- Ruby versions lower than 2.4 are soft-deprecated and will not be run as part
+  of the CI process any longer.
+
+- Akinora MUSHA (knu) added the ability for `Diff::LCS::Change` objects to be
+  implicitly treated arrays. Originally provided as pull request [#47][pull-47],
+  but it introduced a number of test failures as documented in [#48][issue-48],
+  and remediation of `Diff::LCS` itself was introduced in [#49][pull-49].
+
+- Resolved [#5][issue-05] with some tests comparing output from `system` calls
+  to `bin/ldiff` with some pre-generated output. Resolved [#6][issue-06] with
+  these tests.
+
+- Resolved a previously undetected `bin/ldiff` issue with `--context` output not
+  matching `diff --context` output.
+
+- Resolved an issue with later versions of Ruby not working with an `OptParse`
+  specification of `Numeric`; this has been changed to `Integer`.
+
+- Brandon Fish added TruffleRuby in [#52][pull-52].
+
+- Fixed two missing classes as reported in [#53][issue-53].
+
+## 1.3 / 2017-01-18
+
+- Bugs fixed:
+
+  - Fixed an error for `bin/ldiff --version`. Fixes issue [#21][issue-21].
+
+  - Force `Diff::LCS::Change` and `Diff::LCS::ContextChange` to only perform
+    equality comparisons against themselves. Provided by Kevin Mook in pull
+    request [#29][pull-29].
+
+  - Fix tab expansion in `htmldiff`, provided by Mark Friedgan in pull request
+    [#25][pull-25].
+
+  - Silence Ruby 2.4 `Fixnum` deprecation warnings. Fixes issue [#38][issue-38]
+    and pull request [#36][pull-36].
+
+  - Ensure that test dependencies are loaded properly. Fixes issue
+    [#33][issue-33] and pull request [#34][pull-34].
+
+  - Fix issue [#1][issue-01] with incorrect intuition of patch direction.
+    Tentative fix, but the previous failure cases pass now.
+
+- Tooling changes:
+
+  - Added SimpleCov and Coveralls support.
+
+  - Change the homepage (temporarily) to the GitHub repo.
+
+  - Updated testing and gem infrastructure.
+
+  - Modernized the specs.
+
+- Cleaned up documentation.
+
+- Added a Code of Conduct.
+
+## 1.2.5 / 2013-11-08
+
+- Bugs fixed:
+
+  - Comparing arrays flattened them too far, especially with `Diff::LCS.sdiff`.
+    Fixed by Josh Bronson in pull request [#23][pull-23].
+
+## 1.2.4 / 2013-04-20
+
+- Bugs fixed:
+
+  - A bug was introduced after 1.1.3 when pruning common sequences at the start
+    of comparison. Paul Kunysch (@pck) fixed this in pull request
+    [#18][pull-18]. Thanks!
+
+  - The Rubinius (1.9 mode) bug in [rubinius/rubinius#2268][rubinius#2268] has
+    been fixed by the Rubinius team two days after it was filed. Thanks for
+    fixing this so quickly!
+
+- Switching to Raggi's hoe-gemspec2 for gemspec generation.
+
+## 1.2.3 / 2013-04-11
+
+- Bugs Fixed:
+
+  - The new encoding detection for diff output generation (added in 1.2.2)
+    introduced a bug if the left side of the comparison was the empty set.
+    Originally found in [rspec/rspec-expectations#238][rspec-expectations#238]
+    and [rspec/rspec-expectations#239][rspec-expectations#239]. Jon Rowe
+    developed a reasonable heuristic (left side, right side, empty string
+    literal) to avoid this bug.
+
+  - There is a known issue with Rubinius in 1.9 mode reported in
+    [rubinius/rubinius#2268][rubinius#2268] and demonstrated in the Travis CI
+    builds. For all other tested platforms, diff-lcs is considered stable. As
+    soon as a suitably small test-case can be created for the Rubinius team to
+    examine, this will be added to the Rubinius issue around this.
+
+## 1.2.2 / 2013-03-30
+
+- Bugs Fixed:
+
+  - `Diff::LCS::Hunk` could not properly generate a difference for comparison
+    sets that are not US-ASCII-compatible because of the use of literal regular
+    expressions and strings. Jon Rowe found this in
+    [rspec/rspec-expectations#219][rspec-expectations#219] and provided a first
+    pass implementation in pull request [#15][pull-15]. I've reworked it because
+    of test failures in Rubinius when running in Ruby 1.9 mode. This coerces the
+    added values to the encoding of the old dataset (as determined by the first
+    piece of the old dataset).
+
+  - Adding Travis CI testing for Ruby 2.0.
+
+## 1.2.1 / 2013-02-09
+
+- Bugs Fixed:
+
+  - As seen in [rspec/rspec-expectations#200][rspec-expectations#200], the
+    release of `Diff::LCS` 1.2 introduced an unnecessary public API change to
+    `Diff::LCS::Hunk` (see the change at
+    [rspec/rspec-expectations@3d6fc82c][rspec-expectations@3d6fc82c] for
+    details). The new method name (and behaviour) is more correct, but I should
+    not have renamed the function or should have at least provided an alias.
+    This release restores `Diff::LCS::Hunk#unshift` as an alias to #merge. Note
+    that the old `#unshift` behaviour was incorrect and will not be restored.
+
+## 1.2.0 / 2013-01-21
+
+- Minor Enhancements:
+
+  - Added special case handling for `Diff::LCS.patch` so that it handles patches
+    that are empty or contain no changes.
+
+  - Added two new methods (`#patch_me` and `#unpatch_me`) to the include-able
+    module.
+
+- Bugs Fixed:
+
+  - Fixed issue [#1][issue-01] patch direction detection.
+
+  - Resolved issue [#2][issue-02] by handling `string[string.size, 1]` properly
+    (it returns `""` not `nil`).
+
+  - Michael Granger (ged) fixed an implementation error in `Diff::LCS::Change`
+    and added specs in pull request [#8][pull-08]. Thanks!
+
+  - Made the code auto-testable.
+
+  - Vít Ondruch (voxik) provided the latest version of the GPL2 license file in
+    pull request [#10][pull-10]. Thanks!
+
+  - Fixed a documentation issue with the include-able versions of `#patch!` and
+    `#unpatch!` where they implied that they would replace the original value.
+    Given that `Diff::LCS.patch` always returns a copy, the documentation was
+    incorrect and has been corrected. To provide the behaviour that was
+    originally documented, two new methods were added to provide this behaviour.
+    Found by scooter-dangle in issue [#12][issue-12]. Thanks!
+
+- Code Style Changes:
+
+  - Removed trailing spaces.
+
+  - Calling class methods using `.` instead of `::`.
+
+  - Vít Ondruch (voxik) removed unnecessary shebangs in pull request
+    [#9][pull-09]. Thanks!
+
+  - Kenichi Kamiya (kachick) removed some warnings of an unused variable in
+    lucky pull request [#13][pull-13]. Thanks!
+
+  - Embarked on a major refactoring to make the files a little more manageable
+    and understand the code on a deeper level.
+
+  - Adding CI via Travis CI.
+
+## 1.1.3 / 2011-08-27
+
+- Converted to 'hoe' for release.
+
+- Converted tests to RSpec 2.
+
+- Extracted the body of `htmldiff` into a class available from
+  `diff/lcs/htmldiff`.
+
+- Migrated development and issue tracking to GitHub.
+
+- Bugs fixed:
+
+  - Eliminated the explicit use of RubyGems in both `bin/htmldiff` and
+    `bin/ldiff`. Resolves issue [#4][issue-04].
+
+  - Eliminated Ruby warnings. Resolves issue [#3][issue-03].
+
+## 1.1.2 / 2004-10-20
+
+- Fixed a problem reported by Mauricio Fernandez in `htmldiff`.
+
+## 1.1.1 / 2004-09-25
+
+- Fixed bug #891 (Set returned from patch command does not contain last equal
+  part).
+
+- Fixed a problem with callback initialisation code (it assumed that all
+  callbacks passed as classes can be initialised; now, it rescues NoMethodError
+  in the event of private :new being called).
+
+- Modified the non-initialisable callbacks to have a private `#new` method.
+
+- Moved `ldiff` core code to `Diff::LCS::Ldiff` (`diff/lcs/ldiff.rb`).
+
+## 1.1.0
+
+- Eliminated the need for `Diff::LCS::Event` and removed it.
+
+- Added a contextual diff callback, `Diff::LCS::ContextDiffCallback`.
+
+- Implemented (un-)patching for standard diff callback output formats with both
+  `#diff` and `#sdiff`.
+
+- Extensive documentation changes.
+
+## 1.0.4
+
+- Fixed a problem with `bin/ldiff` output, especially for unified format.
+  Newlines that should have been present weren't.
+
+- Changed the `.tar.gz` installer to generate Windows batch files if ones do not
+  exist already. Removed the existing batch files as they didn't work.
+
+## 1.0.3
+
+- Fixed a problem with `#traverse_sequences` where the first difference from the
+  left sequence might not be appropriately captured.
+
+## 1.0.2
+
+- Fixed an issue with `ldiff` not working because actions were changed from
+  symbols to strings.
+
+## 1.0.1
+
+- Minor modifications to the `gemspec`, the `README`.
+
+- Renamed the diff program to `ldiff` (as well as the companion batch file) so
+  as to not collide with the standard diff program.
+
+- Fixed issues with RubyGems. Requires RubyGems > 0.6.1 or >= 0.6.1 with the
+  latest CVS version.
+
+## 1.0
+
+- Initial release based mostly on Perl's Algorithm::Diff.
+
+[age]: https://github.com/FiloSottile/age
+[hoe-halostatue]: https://github.com/halostatue/hoe-halostatue
+[hoe-markdown]: https://github.com/flavorjones/hoe-markdown
+[issue-01]: https://github.com/halostatue/diff-lcs/issues/1
+[issue-02]: https://github.com/halostatue/diff-lcs/issues/2
+[issue-03]: https://github.com/halostatue/diff-lcs/issues/3
+[issue-04]: https://github.com/halostatue/diff-lcs/issues/4
+[issue-05]: https://github.com/halostatue/diff-lcs/issues/5
+[issue-06]: https://github.com/halostatue/diff-lcs/issues/6
+[issue-12]: https://github.com/halostatue/diff-lcs/issues/12
+[issue-21]: https://github.com/halostatue/diff-lcs/issues/21
+[issue-33]: https://github.com/halostatue/diff-lcs/issues/33
+[issue-35]: https://github.com/halostatue/diff-lcs/issues/35
+[issue-38]: https://github.com/halostatue/diff-lcs/issues/38
+[issue-43]: https://github.com/halostatue/diff-lcs/issues/43
+[issue-44]: https://github.com/halostatue/diff-lcs/issues/44
+[issue-46]: https://github.com/halostatue/diff-lcs/issues/46
+[issue-48]: https://github.com/halostatue/diff-lcs/issues/48
+[issue-53]: https://github.com/halostatue/diff-lcs/issues/53
+[issue-57]: https://github.com/halostatue/diff-lcs/issues/57
+[issue-60]: https://github.com/halostatue/diff-lcs/issues/60
+[issue-63]: https://github.com/halostatue/diff-lcs/issues/63
+[issue-65]: https://github.com/halostatue/diff-lcs/issues/65
+[issue-70]: https://github.com/halostatue/diff-lcs/issues/70
+[issue-91]: https://github.com/halostatue/diff-lcs/issues/91
+[issue-95]: https://github.com/halostatue/diff-lcs/issues/95
+[issue-100]: https://github.com/halostatue/diff-lcs/issues/100
+[issue-102]: https://github.com/halostatue/diff-lcs/issues/102
+[issue-106]: https://github.com/halostatue/diff-lcs/issues/106
+[issue-107]: https://github.com/halostatue/diff-lcs/issues/107
+[pull-08]: https://github.com/halostatue/diff-lcs/pull/8
+[pull-09]: https://github.com/halostatue/diff-lcs/pull/9
+[pull-10]: https://github.com/halostatue/diff-lcs/pull/10
+[pull-13]: https://github.com/halostatue/diff-lcs/pull/13
+[pull-15]: https://github.com/halostatue/diff-lcs/pull/15
+[pull-18]: https://github.com/halostatue/diff-lcs/pull/18
+[pull-23]: https://github.com/halostatue/diff-lcs/pull/23
+[pull-25]: https://github.com/halostatue/diff-lcs/pull/25
+[pull-29]: https://github.com/halostatue/diff-lcs/pull/29
+[pull-34]: https://github.com/halostatue/diff-lcs/pull/34
+[pull-36]: https://github.com/halostatue/diff-lcs/pull/36
+[pull-47]: https://github.com/halostatue/diff-lcs/pull/47
+[pull-49]: https://github.com/halostatue/diff-lcs/pull/49
+[pull-52]: https://github.com/halostatue/diff-lcs/pull/52
+[pull-58]: https://github.com/halostatue/diff-lcs/pull/58
+[pull-59]: https://github.com/halostatue/diff-lcs/pull/59
+[pull-61]: https://github.com/halostatue/diff-lcs/pull/61
+[pull-69]: https://github.com/halostatue/diff-lcs/pull/69
+[pull-71]: https://github.com/halostatue/diff-lcs/pull/71
+[pull-72]: https://github.com/halostatue/diff-lcs/pull/72
+[pull-73]: https://github.com/halostatue/diff-lcs/pull/73
+[pull-75]: https://github.com/halostatue/diff-lcs/pull/75
+[pull-79]: https://github.com/halostatue/diff-lcs/pull/79
+[pull-80]: https://github.com/halostatue/diff-lcs/pull/80
+[pull-82]: https://github.com/halostatue/diff-lcs/pull/82
+[pull-84]: https://github.com/halostatue/diff-lcs/pull/84
+[pull-86]: https://github.com/halostatue/diff-lcs/pull/86
+[pull-89]: https://github.com/halostatue/diff-lcs/pull/89
+[pull-90]: https://github.com/halostatue/diff-lcs/pull/90
+[pull-92]: https://github.com/halostatue/diff-lcs/pull/92
+[pull-93]: https://github.com/halostatue/diff-lcs/pull/93
+[pull-101]: https://github.com/halostatue/diff-lcs/pull/101
+[pull-103]: https://github.com/halostatue/diff-lcs/pull/103
+[pull-104]: https://github.com/halostatue/diff-lcs/pull/104
+[pull-105]: https://github.com/halostatue/diff-lcs/pull/105
+[rspec-expectations#200]: https://github.com/rspec/rspec-expectations/pull/200
+[rspec-expectations#219]: https://github.com/rspec/rspec-expectations/issues/219
+[rspec-expectations#238]: https://github.com/rspec/rspec-expectations/issues/238
+[rspec-expectations#239]: https://github.com/rspec/rspec-expectations/issues/239
+[rspec-expectations@3d6fc82c]: https://github.com/rspec/rspec-expectations/commit/3d6fc82c
+[rubinius#2268]: https://github.com/rubinius/rubinius/issues/2268
+[standard ruby]: https://github.com/standardrb/standard
+[tidelift]: https://tidelift.com/security

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- 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 email 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 [INSERT CONTACT
+METHOD]. 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.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+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>.
+
+[homepage]: https://www.contributor-covenant.org
+[Mozilla CoC]: https://github.com/mozilla/diversity