From e686f6c74aef0bfcdc80afb3841452129e96140e Mon Sep 17 00:00:00 2001 From: Simon van Lierde <90462640+simonvanlierde@users.noreply.github.com> Date: Fri, 30 Oct 2026 19:03:03 +0100 Subject: [PATCH 1/2] docs: add a code of conduct, issue forms and a pull request template - CODE_OF_CONDUCT.md is Contributor Covenant 3.0, with reports going by email - Issue forms for bugs and feature requests; blank issues are off, and the contact links point at CONTRIBUTING.md and private security advisories - A pull request template that matches the squash-commit rule Signed-off-by: Simon van Lierde <90462640+simonvanlierde@users.noreply.github.com> --- .github/CODE_OF_CONDUCT.md | 83 ++++++++++++++++++++++++++++++ .github/CONTRIBUTING.md | 4 +- .github/ISSUE_TEMPLATE/bug.yml | 34 ++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 ++++ .github/ISSUE_TEMPLATE/feature.yml | 23 +++++++++ .github/pull_request_template.md | 9 ++++ CHANGELOG.md | 2 + README.md | 1 + 8 files changed, 164 insertions(+), 1 deletion(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bfd0fac --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,83 @@ +# Contributor Covenant 3.0 Code of Conduct + +## Our Pledge + +We pledge to make our community welcoming, safe, and equitable for all. + +We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant. + +## Encouraged Behaviors + +While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language. + +With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: + +1. Respecting the **purpose of our community**, our activities, and our ways of gathering. +2. Engaging **kindly and honestly** with others. +3. Respecting **different viewpoints** and experiences. +4. **Taking responsibility** for our actions and contributions. +5. Gracefully giving and accepting **constructive feedback**. +6. Committing to **repairing harm** when it occurs. +7. Behaving in other ways that promote and sustain the **well-being of our community**. + +## Restricted Behaviors + +We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. + +1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. +2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. +3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits. +4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. +5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. +6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. +7. Behaving in other ways that **threaten the well-being** of our community. + +### Other Restrictions + +1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. +2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. +3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. +4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. + +## Reporting an Issue + +Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. + +When an incident does occur, it is important to report it promptly. To report a possible violation, send an email to . A report about the maintainer can go to GitHub instead, through [Report abuse](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam). + +Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. + +## Addressing and Repairing Harm + +If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped. + +1) Warning + 1) Event: A violation involving a single incident or series of incidents. + 2) Consequence: A private, written warning from the Community Moderators. + 3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. +2) Temporarily Limited Activities + 1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. + 2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. + 3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. +3) Temporary Suspension + 1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. + 2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. + 3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. +4) Permanent Ban + 1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. + 2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. + 3) Repair: There is no possible repair in cases of this severity. + +This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other 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. + +## Attribution + +This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). + +Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) + +For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion). diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5a5cb0e..d59dcd6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,7 +2,8 @@ Thank you for your interest in the observability stack. Bug reports, feature requests and pull requests are welcome. Report vulnerabilities as [SECURITY.md](SECURITY.md) describes, -not in a public issue. +not in a public issue. Everyone taking part follows the +[Code of Conduct](CODE_OF_CONDUCT.md). ## Report a bug or ask for a feature @@ -36,6 +37,7 @@ telemetry, and `just fmt` formats the YAML. CI runs `just lint`, `just validate` when the change needs one, with a bullet per logical chunk. The commit-msg hook refuses a first line that breaks the rule. - **The pull request title** becomes the squash commit subject, so it follows the same rule. +- **The pull request body** starts from the [template](pull_request_template.md). - **The changelog** ([CHANGELOG.md](../CHANGELOG.md)) follows [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/). Write each entry for the people who run the stack or connect a project to it, not as a commit subject. Mark diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..e401e73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,34 @@ +name: Bug report +description: Something does not work as the docs say +labels: [bug] +body: + - type: markdown + attributes: + value: Report a vulnerability as SECURITY.md says, not here. + - type: textarea + id: what-happened + attributes: + label: What happened + description: What you did, what you expected, and what happened instead. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: The smallest set of commands or code that shows the bug. + render: shell + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: The release or commit you used. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Host operating system, and the Docker and Compose versions (`docker version`, `docker compose version`). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..4168af5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +# Questions go to CONTRIBUTING.md, so the issue list holds bugs and feature requests only. +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/CMLPlatform/monitoring/blob/main/.github/CONTRIBUTING.md + about: How to get help, and what this project takes on. + - name: Report a vulnerability + url: https://github.com/CMLPlatform/monitoring/security/advisories/new + about: Privately, as SECURITY.md says. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..1013262 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,23 @@ +name: Feature request +description: Something the project should do that it does not +labels: [enhancement] +body: + - type: textarea + id: problem + attributes: + label: The problem + description: What you are trying to do, and why the project gets in the way today. + validations: + required: true + - type: textarea + id: proposal + attributes: + label: What you propose + description: How it could work. Say if you would open the pull request yourself. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Workarounds or other designs you considered. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..04b7e4c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ + + + +What this fixes or adds, and why, in a sentence or two. + +- What changed, one bullet per logical chunk. +- Three or four bullets are enough. + +Tests: what you ran, or why no test applies. diff --git a/CHANGELOG.md b/CHANGELOG.md index 6c8a0e3..c14953d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,8 @@ Notable changes to this stack. Format follows `CONTRIBUTING.md` covers issues, pull requests and the checks. - An OpenSSF Scorecard run, weekly and on each push to `main`, with its score as a README badge. +- A code of conduct (Contributor Covenant 3.0), issue forms for bugs and + feature requests, and a pull request template. ### Changed diff --git a/README.md b/README.md index 83d0a2b..be49988 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,7 @@ file. | [CHANGELOG.md](CHANGELOG.md) | Release history | | [CONTRIBUTING.md](.github/CONTRIBUTING.md) | Issues, pull requests, checks, commit style | | [SECURITY.md](.github/SECURITY.md) | Reporting a vulnerability, and what is in scope | +| [Code of Conduct](.github/CODE_OF_CONDUCT.md) | How we treat each other, and how to report a problem | Licensed under the [MIT License](LICENSE). To cite the stack, use GitHub's "Cite this repository" button, which reads [CITATION.cff](CITATION.cff). From 5f594bd3e59ae9a9ce327364ebccc1e30299925f Mon Sep 17 00:00:00 2001 From: Simon van Lierde <90462640+simonvanlierde@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:49:27 +0100 Subject: [PATCH 2/2] docs: send code of conduct reports to the cml address Signed-off-by: Simon van Lierde <90462640+simonvanlierde@users.noreply.github.com> --- .github/CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index bfd0fac..f620863 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -43,7 +43,7 @@ We agree to restrict the following behaviors in our community. Instances, threat Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. -When an incident does occur, it is important to report it promptly. To report a possible violation, send an email to . A report about the maintainer can go to GitHub instead, through [Report abuse](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam). +When an incident does occur, it is important to report it promptly. To report a possible violation, send an email to . A report about the maintainer can go to GitHub instead, through [Report abuse](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam). Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.