standard_id-apple 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75dbd2b3cec3ede939959396e75f19d8aea74524af5d94a19ceb3a88ac35fea5
-  data.tar.gz: a8cbbae0a326e7289c8bd537ab61451a90c39bd93ecca72d6f6aff4c4cc34736
+  metadata.gz: 3886bf49958b7ea2704e0491b0e7225c7f82b0d80ca7ab0dcca192b69e7bc1fa
+  data.tar.gz: 804f776780574d8457d6037148148c823a1011ffe3e68a8b84362c821f61c623
 SHA512:
-  metadata.gz: b34faef3f56f6b1f8e6753b99dbdf5ed11170ecd6d666f3096d3c206b09ccbde0ed9177868c737abd401b8e5025699268b2e9272e106053b87cf355932ad57c9
-  data.tar.gz: 98dededac1c594d78d430c0c0ccb103912f997cce6369642921fd5568a078ecf9f375bea01535b6373b76e8cc9ac6cf1a3ffd0ddd92fcd78b24eac9a9892b704
+  metadata.gz: f124007a84b444fd05c29af8c990cb878a1f9c63a2947309ca719f7e8bda6c0cdbd78d5d793ad404257dca8115ee8b59e5fdc28e320825db75267266826ed261
+  data.tar.gz: f90487e071ce29728dab12aa31cee722828e54056b90541ca606ea3e54e4728cba7d7f8458fbfe966212b3b2ce1f99afdda2ead034d7c959c7c17ee71fd8ceae

data/CHANGELOG.md

@@ -7,6 +7,76 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2026-07-31
+
+### Added
+
+- **Install generator: `bin/rails g standard_id:apple:install`.** Writes
+  `config/initializers/standard_id_apple.rb` with all five `social.apple_*`
+  fields wired to ENV, then prints the environment variables the host has to
+  set (including the warning that `APPLE_PRIVATE_KEY_PEM` is multi-line and
+  that a secret store which flattens it to literal `\n` produces a key that
+  parses but fails to sign — surfacing as a JWT error at callback time, not at
+  boot). Idempotent: re-running skips an existing initializer; `--force`
+  overwrites, `--skip-initializer` writes nothing.
+
+  It writes a **separate** file rather than editing `standard_id.rb`, so the
+  provider can be removed by deleting one file and `standard_id`'s own install
+  generator stays free to overwrite its initializer without clobbering these
+  credentials. Initializers load alphabetically, so the base config is applied
+  first. The generated file uses the `config.social.` form throughout — a spec
+  pins that it never emits the unqualified `config.apple_*` form, which works
+  today only because the names happen to be unique across scopes.
+
+  Five of the nine `standard_*` gems shipped an install generator and this was
+  not one of them, which left both consumers assembling the block from the
+  README by hand.
+
+### Documentation
+
+- **Consumer list corrected in `CLAUDE.md`: this gem has two consumers, not
+  one.** It named `luminality-web` only; `sidekick-web` also consumes it. Both
+  live in sibling workspaces rather than beside this repo, which is how the
+  second one went unnoticed.
+
+- **Corrected the Configuration section, which was wrong in two ways.**
+
+  It showed the *flat* form (`config.apple_client_id = ...`) rather than the
+  `social` scope the fields actually live in. The flat form works — StandardId
+  routes an unqualified name to the owning scope when it is unique across scopes
+  — but only once the field is declared, and it silently breaks the day another
+  scope declares a colliding name. Existing code using it is not broken.
+
+  It also documented a form that raised on `standard_id` <= 0.32.0. These fields
+  are declared by this gem, and until `standard_id` 0.33.0 they were declared
+  from this gem's Railtie `after_initialize` — after `config/initializers` — so
+  the plain initializer raised `StandardId::ConfigurationError: Unknown field
+  'apple_client_id' for scope 'social'`. The README now records the
+  `after_initialize` workaround for older `standard_id`, states that 0.33.0
+  declares provider fields before `:load_config_initializers` so the plain form
+  is correct there, and notes that the fields do not exist at all without this
+  gem in the Gemfile — on any `standard_id` version.
+
+### Changed
+
+- **`standard_id` dependency tightened from `~> 0.1, >= 0.1.7` to `~> 0.29.0`.**
+  The old constraint claimed compatibility with every `0.x` release while this
+  plugin reaches into `StandardId::ProviderRegistry` and
+  `StandardId::Providers::Apple`, and `standard_id` is pre-1.0 with breaking
+  minors. Bundler would happily resolve against an untested minor and fail at
+  runtime instead of at resolution. Both current consumers already pin
+  `standard_id "~> 0.29.0"`, so nothing existing is affected.
+
+### Fixed
+
+- Gemspec now uses an allow-list (`Dir["lib/**/*", …]`) rather than a
+  `git ls-files` reject-list. A reject-list fails **open** — new files ship
+  unless someone remembers to exclude them, which is how `.claude/` reached
+  published `0.3.0` of `standard_id-google` (rarebit-one/standard_id-google#69).
+  Drops `.editorconfig`, `.pinact.yaml`, `.rspec`, `.rubocop.yml`,
+  `.ruby-version`, `AGENTS.md`, `CLAUDE.md`, and `CODE_OF_CONDUCT.md` from the
+  package; `lib/` is byte-identical.
+
 ## [0.4.0] - 2026-05-19
 
 ### Changed

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Jaryl Sim
+Copyright (c) 2026 Rarebit One
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -20,22 +20,76 @@ bundle install
 
 The gem automatically registers itself with StandardId when it is required.
 
+Then run the install generator to drop the credentials block in place:
+
+```bash
+bin/rails g standard_id:apple:install
+```
+
+This writes `config/initializers/standard_id_apple.rb` — deliberately a
+separate file from `config/initializers/standard_id.rb`, so the provider can be
+removed by deleting one file and `standard_id`'s own install generator stays
+free to overwrite its initializer without clobbering these values. Initializers
+load alphabetically, so the base config is applied first. The generator is
+idempotent; re-running on an existing initializer skips with a clear message
+(pass `--force` to overwrite).
+
 ## Configuration
 
-Configure Apple credentials via the StandardId configuration block:
+The generator writes this for you; the block is documented here for hosts
+configuring by hand. Configure Apple credentials via the StandardId
+configuration block, in the `social` scope:
 
 ```ruby
+# config/initializers/standard_id.rb
 StandardId.configure do |config|
-  config.apple_client_id = ENV["APPLE_CLIENT_ID"]
-  config.apple_mobile_client_id = ENV["APPLE_MOBILE_CLIENT_ID"] # optional
-  config.apple_team_id = ENV["APPLE_TEAM_ID"]
-  config.apple_key_id = ENV["APPLE_KEY_ID"]
-  config.apple_private_key = ENV["APPLE_PRIVATE_KEY_PEM"]
+  config.social.apple_client_id = ENV["APPLE_CLIENT_ID"]
+  config.social.apple_mobile_client_id = ENV["APPLE_MOBILE_CLIENT_ID"] # optional
+  config.social.apple_team_id = ENV["APPLE_TEAM_ID"]
+  config.social.apple_key_id = ENV["APPLE_KEY_ID"]
+  config.social.apple_private_key = ENV["APPLE_PRIVATE_KEY_PEM"]
 end
 ```
 
 With those values in place, StandardId routes such as `/auth/callback/apple` continue to function using this provider gem.
 
+### Two corrections to earlier versions of this section
+
+**The `social.` prefix.** This section previously showed the flat form
+(`config.apple_client_id = ...`). That happens to work — `StandardId`'s top-level
+config routes an unqualified name to the owning scope when it is unique across
+scopes, and these five are — but only *after* the field has been declared, and it
+is the wrong thing to document: the fields live in the `social` scope, the
+install template writes them there, and the flat form silently stops working the
+day another scope declares a colliding name. Existing code using the flat form is
+not broken and needs no change.
+
+**Boot ordering.** These fields are declared by *this gem*, not by
+`standard_id`, and until `standard_id` 0.33.0 they were declared from this gem's
+Railtie `after_initialize` — which runs *after* `config/initializers`. On
+`standard_id` **0.32.0 and earlier**, the block above therefore raised:
+
+```
+StandardId::ConfigurationError: Unknown field 'apple_client_id' for scope 'social'
+```
+
+The workaround was to wrap the writes:
+
+```ruby
+# Only needed on standard_id <= 0.32.0
+Rails.application.config.after_initialize do
+  StandardId.configure { |config| config.social.apple_client_id = ENV["APPLE_CLIENT_ID"] }
+end
+```
+
+`standard_id` **>= 0.33.0** declares every loaded provider's fields before
+`:load_config_initializers`, so a plain initializer is correct. The wrapper is no
+longer needed and existing ones keep working unchanged.
+
+Note this is about *ordering*, not just versions: **the fields do not exist
+without this gem in your Gemfile**, on any `standard_id` version. Configuring
+`social.apple_*` with the plugin absent raises the same error, correctly.
+
 ## Testing
 
 Run the spec suite:
@@ -56,4 +110,4 @@ To release a new version:
 
 ## License
 
-MIT — see [LICENSE.txt](LICENSE.txt).
+MIT — see [LICENSE](LICENSE).

data/lib/generators/standard_id/apple/install/install_generator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module StandardId
+  module Apple
+    module Generators
+      # Installs the Apple provider's credentials block in a host Rails app.
+      #
+      # Writes `config/initializers/standard_id_apple.rb` — a separate file from
+      # `config/initializers/standard_id.rb` on purpose. The provider is opt-in
+      # per app, so its credentials should be removable by deleting one file,
+      # and `standard_id`'s own install generator must stay free to overwrite
+      # its initializer without clobbering these five values.
+      #
+      # Initializers load alphabetically, so `standard_id.rb` runs before
+      # `standard_id_apple.rb` — the base configuration is already applied by
+      # the time this file sets the `social.apple_*` fields.
+      #
+      # Idempotent: re-running skips an initializer that is already there.
+      # `--skip-initializer` opts out; `--force` overwrites.
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        INITIALIZER_PATH = "config/initializers/standard_id_apple.rb"
+
+        desc <<~DESC
+          Installs StandardId Apple. This writes #{INITIALIZER_PATH} with the
+          five social.apple_* fields wired to ENV, and prints the env vars the
+          host needs to set.
+
+          The generator is idempotent — an existing initializer is skipped with
+          a clear message. Pass --force to overwrite.
+        DESC
+
+        class_option :skip_initializer, type: :boolean, default: false,
+          desc: "Do not write #{INITIALIZER_PATH}"
+        class_option :force, type: :boolean, default: false,
+          desc: "Overwrite #{INITIALIZER_PATH} if it already exists"
+
+        def copy_initializer
+          if options[:skip_initializer]
+            say_status("skip", "#{INITIALIZER_PATH} (--skip-initializer)", :yellow)
+            return
+          end
+
+          if File.exist?(File.join(destination_root, INITIALIZER_PATH)) && !options[:force]
+            say_status("identical", "#{INITIALIZER_PATH} (already exists; pass --force to overwrite)", :blue)
+            return
+          end
+
+          template "initializer.rb.erb", INITIALIZER_PATH, force: options[:force]
+        end
+
+        def print_env_hint
+          return if options[:skip_initializer]
+
+          say ""
+          say "=" * 79
+          say "StandardId Apple installed."
+          say ""
+          say "Set these in the host's environment (1Password / DO app spec / .env):"
+          say ""
+          say "  APPLE_CLIENT_ID         the Services ID (web sign-in)"
+          say "  APPLE_MOBILE_CLIENT_ID  the iOS bundle ID — optional, web-only apps skip it"
+          say "  APPLE_TEAM_ID           the 10-character Apple Developer team ID"
+          say "  APPLE_KEY_ID            the key ID of the Sign In with Apple private key"
+          say "  APPLE_PRIVATE_KEY_PEM   the .p8 private key contents, PEM, newlines intact"
+          say ""
+          say "APPLE_PRIVATE_KEY_PEM is multi-line. Most secret stores flatten it to"
+          say "literal \\n — if sign-in fails on a JWT signing error, that is why."
+          say "=" * 79
+          say ""
+        end
+      end
+    end
+  end
+end

data/lib/generators/standard_id/apple/install/templates/initializer.rb.erb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Apple Sign In credentials for StandardId.
+#
+# These five fields are declared by the standard_id-apple gem, NOT by
+# standard_id — they do not exist unless this gem is in the Gemfile, on any
+# standard_id version. Removing the gem and leaving this file behind raises
+# `StandardId::ConfigurationError: Unknown field 'apple_client_id' for scope
+# 'social'`, which is correct behaviour, not a bug.
+#
+# Set them in the `social` scope, as below. The unqualified form
+# (`config.apple_client_id = ...`) happens to work today because StandardId
+# routes a unique unqualified name to its owning scope, but it stops working
+# the day another scope declares a colliding name. Use `config.social.`.
+#
+# On standard_id <= 0.32.0 these fields were declared from this gem's Railtie
+# `after_initialize`, which runs AFTER config/initializers — so the plain block
+# below raised at boot and had to be wrapped:
+#
+#   Rails.application.config.after_initialize do
+#     StandardId.configure { |config| config.social.apple_client_id = ... }
+#   end
+#
+# standard_id >= 0.33.0 declares every loaded provider's fields before
+# `:load_config_initializers`, so the plain form is correct. Existing wrappers
+# keep working and need no change.
+StandardId.configure do |config|
+  config.social.apple_client_id = ENV["APPLE_CLIENT_ID"]
+
+  # Optional: only set when a native iOS client signs in against the same
+  # backend. Its audience differs from the web Services ID, so leaving it nil
+  # on a web-only app is correct — don't point it at APPLE_CLIENT_ID.
+  config.social.apple_mobile_client_id = ENV["APPLE_MOBILE_CLIENT_ID"]
+
+  config.social.apple_team_id = ENV["APPLE_TEAM_ID"]
+  config.social.apple_key_id = ENV["APPLE_KEY_ID"]
+
+  # The .p8 contents in PEM form, newlines intact. Secret stores that flatten
+  # multi-line values to literal \n produce a key that parses but fails to
+  # sign — surfacing as a JWT error at callback time, not at boot.
+  config.social.apple_private_key = ENV["APPLE_PRIVATE_KEY_PEM"]
+end

data/lib/standard_id/apple/version.rb

@@ -2,6 +2,6 @@
 
 module StandardId
   module Apple
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: standard_id-apple
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jaryl Sim
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -47,22 +47,22 @@ dependencies:
   name: standard_id
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '0.29'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '0.29'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Extracted StandardId::Providers::Apple implementation packaged as a standalone
   gem so StandardId installations can opt into Sign in with Apple independently.
 email:
@@ -71,17 +71,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- AGENTS.md
 - CHANGELOG.md
-- CLAUDE.md
-- CODE_OF_CONDUCT.md
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
+- lib/generators/standard_id/apple/install/install_generator.rb
+- lib/generators/standard_id/apple/install/templates/initializer.rb.erb
 - lib/standard_id/apple.rb
 - lib/standard_id/apple/providers/apple.rb
 - lib/standard_id/apple/railtie.rb

data/.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[Makefile]
-indent_style = tab

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,8 +0,0 @@
-# Omakase Ruby styling for Rails
-inherit_gem: { rubocop-rails-omakase: rubocop.yml }
-
-# Overwrite or add rules to create your own house style
-
-# Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
-Layout/SpaceInsideArrayLiteralBrackets:
-  EnforcedStyle: no_space

data/.ruby-version

@@ -1 +0,0 @@
-4.0.1

data/AGENTS.md

@@ -1,72 +0,0 @@
-# AGENTS.md - AI Agent Guide for standard_id-apple
-
-`standard_id-apple` is a provider plugin for the [StandardId](https://github.com/rarebit-one/standard_id) authentication engine. It packages a `StandardId::Providers::Apple` implementation for Sign in with Apple, and auto-registers itself with the host StandardId installation via a `Rails::Railtie` so apps that bundle the gem don't need an explicit initializer.
-
-## Quick Reference
-
-```bash
-# Run tests
-bundle exec rspec
-
-# Run a single spec file
-bundle exec rspec spec/standard_id/apple/providers/apple_spec.rb
-
-# Run linting (note: --config flag is required on Ruby 4.0)
-bundle exec rubocop --config .rubocop.yml
-
-# Auto-fix lint issues
-bundle exec rubocop --config .rubocop.yml -A
-```
-
-## Project Structure
-
-```
-standard_id-apple/
-├── lib/standard_id/
-│   ├── apple.rb                         # Top-level require entrypoint
-│   └── apple/
-│       ├── version.rb                   # Gem version constant
-│       ├── railtie.rb                   # Auto-registers provider on after_initialize
-│       └── providers/apple.rb           # StandardId::Providers::Apple implementation
-└── spec/
-    ├── spec_helper.rb                   # Boots a minimal Rails app so the Railtie fires
-    └── standard_id/                     # Provider specs
-```
-
-## Key Patterns
-
-### Provider class
-
-`StandardId::Providers::Apple` inherits from `StandardId::Providers::Base` (defined in the parent `standard_id` gem) and implements the provider contract: `provider_name`, `authorization_url`, `get_user_info`, `config_schema`, plus Apple-specific helpers (`verify_id_token`, `generate_client_secret`, JWKS fetching).
-
-### Railtie auto-registration
-
-`StandardId::Apple::Railtie` runs on `config.after_initialize` and calls `StandardId::ProviderRegistry.register(:apple, StandardId::Providers::Apple)`. Host apps just need the gem in their Gemfile — no initializer required.
-
-### Spec bootstrapping
-
-`spec/spec_helper.rb` defines a tiny `Rails::Application` and calls `Rails.application.initialize!` so the Railtie's `after_initialize` hook fires during the spec run; without this the provider would not appear in the registry.
-
-## Key Files
-
-| File | Purpose |
-|------|---------|
-| `lib/standard_id/apple.rb` | Top-level require entrypoint |
-| `lib/standard_id/apple/railtie.rb` | Provider registration on Rails boot |
-| `lib/standard_id/apple/providers/apple.rb` | Apple provider implementation |
-| `lib/standard_id/apple/version.rb` | Gem version constant |
-| `standard_id-apple.gemspec` | Gem metadata + runtime deps |
-
-## Dependencies
-
-- **standard_id** `~> 0.1`, `>= 0.1.7` (parent engine — provides `Providers::Base`, `ProviderRegistry`, errors)
-- **activesupport** `>= 8.0` (`Time.current`, `present?`/`blank?`, indifferent access)
-- **jwt** `~> 2.7` (id_token decoding, client_secret signing)
-
-Dev: rspec, rubocop, webmock, lefthook.
-
-## Testing
-
-- WebMock stubs Apple's JWKS and token endpoints — never make real network calls in specs.
-- The dummy Rails app in `spec_helper.rb` is intentionally minimal; add config via `StandardId.config.apple_*` setters in individual specs rather than expanding the dummy app.
-- CI runs the full Ruby 4.0.x patch matrix via the shared `rarebit-one/.github` reusable workflow.

data/CLAUDE.md

@@ -1,32 +0,0 @@
-# CLAUDE.md
-
-## Worktree-Only Workflow (Enforced)
-
-**All file modifications are blocked in the main checkout.** A PreToolUse hook (`enforce-worktree.sh`) rejects Edit, Write, and NotebookEdit operations targeting files outside a worktree. There are no opt-outs. Do not use Bash to write files in the main checkout either (e.g., `echo >`, `sed -i`, `tee`, `cp`) — the hook cannot intercept shell commands, so this rule is instruction-enforced.
-
-Before writing any code, create a worktree:
-
-```bash
-DEFAULT_BRANCH=$(git symbolic-ref refs/remotes/origin/HEAD 2>/dev/null | sed 's@refs/remotes/origin/@@')
-DEFAULT_BRANCH=${DEFAULT_BRANCH:-main}
-git fetch origin "$DEFAULT_BRANCH"
-git worktree add .worktrees/<name> -b <branch-name> "origin/$DEFAULT_BRANCH"
-```
-
-Then work inside `.worktrees/<name>/` for the rest of the session.
-
-**Naming:** Use the Linear issue identifier if available (e.g., `.worktrees/<identifier>`), a task slug (e.g., `.worktrees/fix-auth-timeout`), or today's date (e.g., `.worktrees/2026-04-01`) as fallback.
-
-**The hook allows modifications only when:**
-
-1. The file is inside a git worktree (detected via `git rev-parse --git-dir` returning a path under `.git/worktrees/`)
-2. Running in a CI/automated context where the checkout is already isolated
-**Why this matters:** Working directly on the main checkout causes cross-contamination between sessions — uncommitted changes, wrong branches, and dirty state leak into unrelated work. Worktrees eliminate this entirely.
-
-See the `/worktree` and `/start` skills for full conventions and flags.
-
-## Consumers
-
-`standard_id-apple` is currently consumed by `luminality-web` only in the rarebit-one workspace. Apple Sign In is a Luminality-only feature; `fundbright-web` and `nutripod-web` do not consume this gem.
-
-After publishing a new version via `/publish-gem`, roll it out with the workspace-level `/rollout-gem standard_id-apple [<version>]` skill (defined at the rarebit-one workspace root, one directory above this repo). The canonical consumer matrix — including version constraints — lives in that skill's `SKILL.md`.

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# 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][v2.1].
-
-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][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations