From 0f8fd78ceba2d2b33467631226b428e2409e6d9f Mon Sep 17 00:00:00 2001 From: Edouard de Labareyre Date: Fri, 7 Nov 2025 13:11:35 +0100 Subject: [PATCH 1/3] Add contributions advices --- CODE_OF_CONDUCT.md | 133 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 18 ++++++ 2 files changed, 151 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..45d257b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# 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 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 +[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 diff --git a/README.md b/README.md index a3473c7..8f17cdd 100644 --- a/README.md +++ b/README.md @@ -442,6 +442,24 @@ Please note that **they aren't both mandatory, but at least one of them MUST** b __Hanami::Mailer__ uses [Semantic Versioning 2.0.0](http://semver.org) +## Contribute + +In the spirit of [free software][free-sw], **everyone** is encouraged to help improve this project. + +If you want to contribute to the code, here are the steps to follow: + +1. [Fork this repository][fork] +2. clone it locally (`git clone git@github.com:your-pseudo/your-cloned-repo.git`) +2. Create your [feature branch][branch] (`git checkout -b my-new-feature`) +3. Install the dependencies (`bundle install`) +4. Run tests, they should all pass (`bundle exec rake`) +5. Make your changes & check that the tests still pass. Add some test cases if needed. +6. Commit your changes (`git commit -am 'Add some feature'`) +7. Push to the branch (`git push origin my-new-feature`) +8. Create new Pull Request on Github with some context on what you're trying to fix or to improve with this contribution + +Thank you for contributing! + ## Copyright Copyright © 2015-2021 Luca Guidi – Released under MIT License From 9317bcb0ad895c952990dd3231dbb48ce6686d71 Mon Sep 17 00:00:00 2001 From: Edouard de Labareyre Date: Fri, 7 Nov 2025 13:19:08 +0100 Subject: [PATCH 2/3] Fix duplicate --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8f17cdd..f656a27 100644 --- a/README.md +++ b/README.md @@ -448,11 +448,10 @@ In the spirit of [free software][free-sw], **everyone** is encouraged to help im If you want to contribute to the code, here are the steps to follow: -1. [Fork this repository][fork] -2. clone it locally (`git clone git@github.com:your-pseudo/your-cloned-repo.git`) -2. Create your [feature branch][branch] (`git checkout -b my-new-feature`) -3. Install the dependencies (`bundle install`) -4. Run tests, they should all pass (`bundle exec rake`) +1. Fork this repo to your account and clone it locally (`git clone git@github.com:your-pseudo/hanami-mailer.git`) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Install the dependencies (`./bin/setup`) +4. Run CI, all checks should all pass (`script/ci`) 5. Make your changes & check that the tests still pass. Add some test cases if needed. 6. Commit your changes (`git commit -am 'Add some feature'`) 7. Push to the branch (`git push origin my-new-feature`) From 31c8db1e070161717a5f34b941099cdb163c9340 Mon Sep 17 00:00:00 2001 From: Edouard de Labareyre Date: Fri, 7 Nov 2025 13:43:10 +0100 Subject: [PATCH 3/3] Fix CI warning about redundant path --- benchmark.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/benchmark.rb b/benchmark.rb index 26a95ab..6cb2405 100644 --- a/benchmark.rb +++ b/benchmark.rb @@ -4,7 +4,7 @@ require "hanami/mailer" require "benchmark/ips" require "allocation_stats" -require_relative "./examples/base" +require_relative "examples/base" configuration = Hanami::Mailer::Configuration.new do |config| config.root = "examples/base"