From cd74e73586e3e036ff466463a52cc92cb11c352f Mon Sep 17 00:00:00 2001 From: Manos Pitsidianakis Date: Tue, 18 Apr 2023 14:45:44 +0300 Subject: [PATCH] Add CODE_OF_CONDUCT.md, CONTRIBUTING.md --- CODE_OF_CONDUCT.md | 128 ++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 102 +++++++++++++++++++++++++++ Makefile | 9 ++- cli/tests/basic_interfaces.rs | 4 +- core/src/lib.rs | 13 ++++ 5 files changed, 251 insertions(+), 5 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..88e89a1 --- /dev/null +++ b/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, 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 +manos@pitsidianak.is. +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3bb6970 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,102 @@ +# Contributing to mailpot + +Contributions are welcome and encouraged. +They can be anything from spelling corrections, art, documentation, or source code fixes & additions. +If a source code contribution is correct, functional and follows the code style and feature goals of the rest of the project, it will be merged. + +**Table of contents**: + +- [Important links](#important-links) +- [Developing environment](#developing-environment) +- [Testing](#testing) +- [How to submit changes](#how-to-submit-changes) +- [Choosing what to work on](#choosing-what-to-work-on) +- [How to request an enhancement, new features](#how-to-request-an-enhancement-new-features) +- [Style Guide / Coding conventions](#style-guide--coding-conventions) +- [Specific questions and answers](#specific-questions-and-answers) + - [How do I include new images / icons?](#how-do-i-include-new-images--icons) + +## Important links + +- Main repository: +- Bug/Issue tracker: +- Mailing list: + +To privately contact the repository's owner, check their commit history for their e-mail address. + +back to top + +## Developing environment + +You will need a UNIX-like operating system that is supported by Rust. +You can install rust and cargo with the [`rustup`](https://rustup.rs) tool. + +back to top + +## Testing + +All tests can be executed with `cargo`. +Run + +```shell +cargo test --all --no-fail-fast --all-features +``` + +to run all tests. + +back to top + +## How to submit changes + +Use gitea's PR functionality. +Alternatively, submit patches to the mailing list. + +back to top + +## Choosing what to work on + +You can find some tasks in the bug tracker. +Additionally, tasks are annotated inside the source code with the keywords `FIXME`, `TODO` and others. +For a list of all tags search for `[tag:`. +For a list of all references search for `[ref:`. +To find tag references you can use a text search tool of your choice such as `grep`, `ripgrep` or others. +The CLI tool `tagref` can also be used: + +```shell +/path/to/mailpot $ tagref list-refs +[ref:FIXME] @ ./src/module.rs:106 +[ref:FIXME] @ ./src/module.rs:867 +[ref:FIXME] @ ./src/module.rs:30 +[ref:TODO] @ ./src/where.rs:411 +... +``` + +You can of course filter or sort them by tag: + +```shell +/path/to/mailpot $ tagref list-refs | grep TODO +... +/path/to/mailpot $ tagref list-refs | sort -u +... +``` + +back to top + +## How to request an enhancement, new features + +Simply open a new issue on the bug tracker or post on the mailing list. + +back to top + +## Style Guide / Coding conventions + +All Rust code must be formatted by `rustfmt`, and pass clippy lints. + +```shell +cargo check --all-features --all --tests --examples --benches --bins +cargo +nightly fmt --all || cargo fmt --all +cargo clippy --no-deps --all-features --all --tests --examples --benches --bins +djhtml -i web/src/templates/* || printf "djhtml binary not found in PATH.\n" +``` + +back to top diff --git a/Makefile b/Makefile index 7705d30..729c13a 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ .PHONY: check check: - cargo check --all + cargo check --all-features --all --tests --examples --benches --bins .PHONY: fmt fmt: @@ -10,4 +10,9 @@ fmt: .PHONY: lint lint: - cargo clippy --all + cargo clippy --no-deps --all-features --all --tests --examples --benches --bins + + +.PHONY: test +test: check lint + cargo test --all --no-fail-fast --all-features diff --git a/cli/tests/basic_interfaces.rs b/cli/tests/basic_interfaces.rs index da6950b..2550788 100644 --- a/cli/tests/basic_interfaces.rs +++ b/cli/tests/basic_interfaces.rs @@ -23,15 +23,13 @@ use std::path::Path; -use assert_cmd::assert::OutputAssertExt; +use assert_cmd::{assert::OutputAssertExt, Command}; use mailpot::{models::*, Configuration, Connection, SendMail}; use predicates::prelude::*; use tempfile::TempDir; #[test] fn test_cli_basic_interfaces() { - use assert_cmd::Command; - fn no_args() { let mut cmd = Command::cargo_bin("mpot").unwrap(); // 2 -> incorrect usage diff --git a/core/src/lib.rs b/core/src/lib.rs index 1704daf..f93e2bb 100644 --- a/core/src/lib.rs +++ b/core/src/lib.rs @@ -124,6 +124,19 @@ //! # do_test(config); //! ``` +/* Annotations: + * + * Global tags (in tagref format ) for source code + * annotation: + * + * - [tag:needs_unit_test] + * - [tag:needs_user_doc] + * - [tag:needs_dev_doc] + * - [tag:FIXME] + * - [tag:TODO] + * - [tag:VERIFY] Verify whether this is the correct way to do something + */ + #[macro_use] extern crate error_chain; extern crate anyhow;