From db3cde52c4e872f2583d355005282971acb84bfd Mon Sep 17 00:00:00 2001 From: "D. Moonfire" Date: Sun, 28 Jan 2024 21:53:54 -0600 Subject: [PATCH] feat: added the ability to write out a Contributor Convenant --- .gitignore | 1 + CODE_OF_CONDUCT.md | 132 +++++++++++++++++ flake.nix | 24 +++- src/configs/contributorCovenant.nix | 143 +++++++++++++++++++ src/configs/default.nix | 17 ++- src/configs/developerCertificateOfOrigin.nix | 43 ++++++ src/engines/text.nix | 18 +++ 7 files changed, 370 insertions(+), 8 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 src/configs/contributorCovenant.nix create mode 100644 src/configs/developerCertificateOfOrigin.nix create mode 100644 src/engines/text.nix diff --git a/.gitignore b/.gitignore index 3aede59..75a9f9e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ .direnv/ # nixago: ignore-linked-files +/DCO.md /rustfmt.toml /treefmt.toml /.prettierrc.json diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4e1590d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# 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 +contact@mfgames.com. 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 diff --git a/flake.nix b/flake.nix index 95e16b4..637bed5 100644 --- a/flake.nix +++ b/flake.nix @@ -28,27 +28,39 @@ { system , pkgs , conform ? { } + , contributorCovenant ? { } + , developerCertificateOfOrigin ? { } , rust ? { } , ... }: let - rustDefaults = { enable = false; }; conformDefaults = { scopes = [ ]; }; + contributorCovenantDefaults = { enable = false; }; + developerCertificateOfOriginDefaults = { enable = false; }; + rustDefaults = { enable = false; }; + + text-engine = import ./src/engines/text.nix { + inherit pkgs; + lib = pkgs.lib; + }; configs = import ./src/configs/default.nix { inherit system pkgs nixago nixago-exts; + + text-engine = text-engine { }; + + contributorCovenant = contributorCovenantDefaults // contributorCovenant; + developerCertificateOfOrigin = developerCertificateOfOriginDefaults // developerCertificateOfOrigin; conform = conformDefaults // conform; rust = rustDefaults // rust; }; in { - packages = [ pkgs.lefthook ]; + packages = [ pkgs.lefthook pkgs.treefmt ]; shellHook = '' ${configs.shellHook} ${pkgs.lefthook}/bin/lefthook install - - alias lefthook="${pkgs.lefthook}/bin/lefthook" ''; }; }; @@ -58,7 +70,9 @@ let config = lib.mkConfig { inherit system pkgs; - #rust.enable = false; + contributorCovenant.enable = true; + contributorCovenant.contact = "contact@mfgames.com"; + developerCertificateOfOrigin.enable = true; }; in { diff --git a/src/configs/contributorCovenant.nix b/src/configs/contributorCovenant.nix new file mode 100644 index 0000000..06f34c9 --- /dev/null +++ b/src/configs/contributorCovenant.nix @@ -0,0 +1,143 @@ +inputs @ { pkgs, text-engine, contributorCovenant, ... }: +assert pkgs.lib.assertMsg + (contributorCovenant ? "contact") "contributorCovenant.contact must be set"; +{ + output = "CODE_OF_CONDUCT.md"; + engine = text-engine; + hook.mode = "copy"; + + data = '' + # 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 + ${contributorCovenant.contact}. + 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 + ''; +} diff --git a/src/configs/default.nix b/src/configs/default.nix index 2b9c4e1..0b55463 100644 --- a/src/configs/default.nix +++ b/src/configs/default.nix @@ -1,12 +1,23 @@ -inputs @ { pkgs, rust ? { enable = false; }, ... }: -let lib = pkgs.lib; in -inputs.nixago.lib.${inputs.system}.makeAll ([ +inputs @ { pkgs +, contributorCovenant +, developerCertificateOfOrigin +, rust +, ... +}: +let lib = pkgs.lib; +in inputs.nixago.lib.${inputs.system}.makeAll ([ (import ./conform.nix (inputs)) (import ./editorconfig.nix (inputs)) (import ./lefthook.nix (inputs)) (import ./prettier.nix (inputs)) (import ./treefmt.nix (inputs)) ] +++ lib.optionals contributorCovenant.enable [ + (import ./contributorCovenant.nix (inputs)) +] +++ lib.optionals developerCertificateOfOrigin.enable [ + (import ./developerCertificateOfOrigin.nix (inputs)) +] ++ lib.optionals rust.enable [ (import ./rustfmt.nix (inputs)) ]) diff --git a/src/configs/developerCertificateOfOrigin.nix b/src/configs/developerCertificateOfOrigin.nix new file mode 100644 index 0000000..d4d3536 --- /dev/null +++ b/src/configs/developerCertificateOfOrigin.nix @@ -0,0 +1,43 @@ +inputs @ { pkgs, text-engine, ... }: +{ + output = "DCO.md"; + engine = text-engine; + hook.mode = "copy"; + + data = '' + Developer Certificate of Origin + Version 1.1 + + Copyright (C) 2004, 2006 The Linux Foundation and its contributors. + + Everyone is permitted to copy and distribute verbatim copies of this + license document, but changing it is not allowed. + + + Developer's Certificate of Origin 1.1 + + By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + ''; +} diff --git a/src/engines/text.nix b/src/engines/text.nix new file mode 100644 index 0000000..28ec580 --- /dev/null +++ b/src/engines/text.nix @@ -0,0 +1,18 @@ +/* + The nix engine uses pkgs.formats for generating output data. + + The engine takes a single parameter (`opts`) which is subsequently passed to + the specified generator when instantiating it. See the pkgs.formats entries + for which options are available for each generator type. + + The `type` field of the request determines which generator is invoked. The + type must be a name in the set produced by `pkgs.formats`. +*/ +{ pkgs, ... }: +opts: request: +let + inherit (request) data format output; + name = "text"; + value = data; +in +pkgs.writeText name value