From 669b0f0ada188ddf96839279d9110f12573b64c6 Mon Sep 17 00:00:00 2001 From: Hugo Date: Thu, 1 Oct 2026 16:51:32 +0200 Subject: [PATCH] docs: add repository governance files and README links --- AUTHORS.md | 7 +++ CHANGELOG.md | 16 ++++++ CODE_OF_CONDUCT.md | 130 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 15 ++++++ README.md | 9 ++++ SECURITY.md | 15 ++++++ 6 files changed, 192 insertions(+) create mode 100644 AUTHORS.md create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..6f76cf9 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,7 @@ +# Authors + +## Maintainers + +- Hugo Payet ([@SizzleUnrlsd](https://github.com/SizzleUnrlsd)) + +Other contributors are credited in this repository's Git history and pull requests. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..bd27995 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +Notable changes are grouped by release. See [all releases](https://github.com/CoreTrace/coretrace-log/releases) for older versions. + +## Unreleased + +- Added repository contribution, conduct and security documentation. + +## v1.1.0 + +- Logging to sinks is serialized, including format-error fallback and sink changes. +- Recursive logging from a sink no longer deadlocks. +- Module filtering and environment defaults behave consistently before the first log. +- `enable_module()` now reports whether a module name was accepted. + +[Full v1.1.0 notes](https://github.com/CoreTrace/coretrace-log/releases/tag/v1.1.0). diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..82b6a49 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,130 @@ +# Contributor Covenant Code of Conduct + +This policy applies to the CoreTrace Logger repository and its community spaces. + +## 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 +hugo.payet@epitech.eu. +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..3a5a776 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing to CoreTrace Logger + +## Local setup + +The [README](README.md#development) describes the development workflow. With CMake, Ninja and a C++20 compiler installed, build and test with: + +```bash +cmake -S . -B build -G Ninja +cmake --build build +ctest --test-dir build --output-on-failure +``` + +Run `./scripts/format-check.sh` before opening a pull request. `./scripts/format.sh` applies the project's clang-format rules. The repository uses English Conventional Commits; `./scripts/setup-dev.sh` installs its local commit-message hook. + +Explain changes to the public logging API or output format and include the test commands you ran. Report security concerns privately through [SECURITY.md](SECURITY.md). diff --git a/README.md b/README.md index d6f5fb5..555c909 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,15 @@ A minimal, fast, and thread-safe C++20 logging library with colored terminal out - Custom sink support (redirect to file, buffer, syslog, etc.) - Small: about 1,300 lines, including the POSIX and Windows backends +## Repository documents + +- [CONTRIBUTING.md](CONTRIBUTING.md) +- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) +- [AUTHORS.md](AUTHORS.md) +- [CHANGELOG.md](CHANGELOG.md) +- [LICENSE](LICENSE) +- [SECURITY.md](SECURITY.md) + ## Quick start ```cpp diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..d11cf3d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,15 @@ +# Security Policy + +## Supported versions + +Security fixes target `main` and the latest tagged release, when one exists. Older tags are not maintained. Include the exact tag or commit in a report. + +## Reporting a vulnerability + +Report privately through [GitHub private vulnerability reporting](https://github.com/CoreTrace/coretrace-log/security/advisories/new). Do not publish a suspected vulnerability in an issue or pull request. + +Include reproduction steps, expected and observed behavior, the affected platform and version, and the possible impact. Remove credentials and other sensitive data from examples. + +## Scope + +CoreTrace Logger is a logging library. Reports about memory safety, thread safety or sink handling should include the relevant configuration and a minimal reproducer.