From a3c7dc534532ff7d02e8d0e6fb932d44776eb7b2 Mon Sep 17 00:00:00 2001 From: Alex Kanitz Date: Tue, 27 Oct 2026 16:22:12 +0100 Subject: [PATCH] docs: use the org-wide community files Remove CODE_OF_CONDUCT.md, PULL_REQUEST_TEMPLATE.md and the general purpose issue template, so that GitHub uses the defaults of elixir-cloud-aai/.github, and point the code of conduct links to the org file. Keep CONTRIBUTING.md with the repository's PR and release steps. Closes #487 Co-Authored-By: Claude Opus 5.5 --- .github/ISSUE_TEMPLATE/general-purpose.md | 22 ---- CODE_OF_CONDUCT.md | 134 ---------------------- CONTRIBUTING.md | 5 +- PULL_REQUEST_TEMPLATE.md | 24 ---- README.md | 12 +- 5 files changed, 8 insertions(+), 189 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/general-purpose.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/general-purpose.md b/.github/ISSUE_TEMPLATE/general-purpose.md deleted file mode 100644 index 1c665eb4..00000000 --- a/.github/ISSUE_TEMPLATE/general-purpose.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: General Purpose -about: This template serves as a general purpose template for bug reports, feature requests, and other queries. -title: 'triage: ' -labels: 'status: new' -assignees: '' ---- - - - - -## Description - - -## Possible solution(s) - - - -## Additional context - - - \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index d33878e1..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,134 +0,0 @@ - -# 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/CONTRIBUTING.md b/CONTRIBUTING.md index ca671b8d..22cbc4ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,8 @@ follows the [contributor guide of ELIXIR On-Cloud](https://elixir-cloud-aai.github.io/contribute/); this file only describes what is specific to this repository. -- Follow our [code of conduct](CODE_OF_CONDUCT.md). +- Follow our [code of + conduct](https://github.com/elixir-cloud-aai/.github/blob/main/CODE_OF_CONDUCT.md). - Work on [issues](https://github.com/elixir-cloud-aai/cloud-components/issues): open or find one and agree on the approach before you change code. @@ -14,7 +15,7 @@ describes what is specific to this repository. 1. Branch off `dev`, the default branch (e.g. `feat/` or `fix/`), and open a pull request against `dev` that references the - issue it closes (e.g. `Fixes #123`, as in the pull request template). + issue it closes (e.g. `Closes #123`, as in the pull request template). `main` points at the latest release; nobody pushes to it except to fast-forward it after a release. 2. Title the pull request as a [Conventional diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index ac950ef3..00000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,24 +0,0 @@ -## Description - - - -Fixes #(issue) - -## Checklist - - - -- [ ] My code follows the [contributing guidelines][contributing] of this project. -- [ ] I am aware that all my commits will be squashed into a single commit, using the PR title as the commit message. -- [ ] I have performed a self-review of my own code. -- [ ] I have commented my code in hard-to-understand areas. -- [ ] I have updated the user-facing documentation to describe any new or changed behavior. -- [ ] My changes generate no new warnings. -- [ ] I have added tests that prove my fix is effective or that my feature works. -- [ ] I have not reduced the existing code coverage. - -## Comments - - - -[contributing]: CONTRIBUTING.md diff --git a/README.md b/README.md index 5acfe889..57876040 100644 --- a/README.md +++ b/README.md @@ -94,14 +94,12 @@ you are interested in contributing. ## Code of Conduct -Please mind the code of conduct described in -[`CODE_OF_CONDUCT.md`][code-of-conduct] for all interactions with the community. -Please be nice to one another! :) +Please mind the [code of conduct][code-of-conduct] of ELIXIR Cloud & AAI for +all interactions with the community. Please be nice to one another! :) If you experience any unacceptable behavior by any member of the community, -please refer to the contact method specified in -[`CODE_OF_CONDUCT.md`][code-of-conduct] to report the incident to the community -leaders. +please report the incident to the community moderators as described in the +[code of conduct][code-of-conduct]. ## Versioning @@ -139,7 +137,7 @@ To get in touch with use, please use one of the following routes: [badge-chat-image]: https://img.shields.io/static/v1?label=chat&message=Slack&color=ff6994 [badge-chat-url]: https://join.slack.com/t/elixir-cloud/shared_invite/enQtNzA3NTQ5Mzg2NjQ3LTZjZGI1OGQ5ZTRiOTRkY2ExMGUxNmQyODAxMDdjM2EyZDQ1YWM0ZGFjOTJhNzg5NjE0YmJiZTZhZDVhOWE4MWM [email]: mailto:alexander.kanitz@alumni.ethz.ch -[code-of-conduct]: CODE_OF_CONDUCT.md +[code-of-conduct]: https://github.com/elixir-cloud-aai/.github/blob/main/CODE_OF_CONDUCT.md [contributing]: CONTRIBUTING.md [contributors]: CONTRIBUTORS.md [elixir]: https://elixir-europe.org/