way_of_working-code_of_conduct-contributor_covenant 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.alexignore +2 -0
- data/.alexrc +3 -0
- data/.mega-linter.yml +145 -0
- data/.rubocop +1 -0
- data/CHANGELOG.md +18 -0
- data/CODE_OF_CONDUCT.md +134 -0
- data/LICENSE.txt +21 -0
- data/README.md +55 -0
- data/Rakefile +16 -0
- data/code_safety.yml +146 -0
- data/docs/way_of_working/code-of-conduct.md +35 -0
- data/docs/way_of_working/inclusive-language.md +28 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant/generators/init.rb +38 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant/github_audit_rule.rb +32 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant/paths.rb +20 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant/plugin.rb +1 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant/templates/CODE_OF_CONDUCT.md.tt +134 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant/templates/docs/way_of_working/code-of-conduct.md +35 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant/version.rb +9 -0
- data/lib/way_of_working/code_of_conduct/contributor_covenant.rb +42 -0
- metadata +96 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 359c640f6a814b70e7874c84c523d9e69dda699ee621faf3fc2b7567b9859b22
|
4
|
+
data.tar.gz: 634b0f4deeb093dfa47aa1dbcbc8db47bb9768276e7f7381fecddba512dbf8be
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f7b0e26934f172f0f3b9e552fb77757bd525ab905a3066311062da105d9d446161ca7b9b35e6d89cc76a75af9ad070cf4bc11310eca776874f0d89fb72235031
|
7
|
+
data.tar.gz: b080012365f2c817648950f2e9b645eaf2d663be26b7d4c78f8600b9466d5dcaba75b8213ba1d6cf386c1044c926cafdc3030390d09e590e3f6db7e269dd1e2c
|
data/.alexignore
ADDED
data/.alexrc
ADDED
data/.mega-linter.yml
ADDED
@@ -0,0 +1,145 @@
|
|
1
|
+
---
|
2
|
+
# Configuration file for MegaLinter
|
3
|
+
# See all available variables at https://megalinter.io/configuration/
|
4
|
+
# and in linters documentation
|
5
|
+
|
6
|
+
APPLY_FIXES: none # all, none, or list of linter keys
|
7
|
+
ENABLE_LINTERS: # All other linters will be disabled by default
|
8
|
+
### Languages
|
9
|
+
- BASH_EXEC # in Super-Linter
|
10
|
+
- BASH_SHELLCHECK # in Super-Linter
|
11
|
+
- BASH_SHFMT # in Super-Linter
|
12
|
+
- C_CLANG_FORMAT
|
13
|
+
- C_CPPLINT
|
14
|
+
# - CLOJURE_CLJ_KONDO # in Super-Linter
|
15
|
+
# - CLOJURE_CLJSTYLE
|
16
|
+
- COFFEE_COFFEELINT # in Super-Linter
|
17
|
+
- CPP_CLANG_FORMAT
|
18
|
+
- CPP_CPPLINT # in Super-Linter
|
19
|
+
- CSHARP_CSHARPIER
|
20
|
+
- CSHARP_DOTNET_FORMAT # in Super-Linter
|
21
|
+
- CSHARP_ROSLYNATOR
|
22
|
+
- DART_DARTANALYZER # in Super-Linter
|
23
|
+
- GO_GOLANGCI_LINT # in Super-Linter
|
24
|
+
- GO_REVIVE
|
25
|
+
# - GROOVY_NPM_GROOVY_LINT # in Super-Linter
|
26
|
+
- JAVA_CHECKSTYLE # in Super-Linter
|
27
|
+
- JAVA_PMD
|
28
|
+
- JAVASCRIPT_ES # in Super-Linter
|
29
|
+
# - JAVASCRIPT_PRETTIER
|
30
|
+
- JAVASCRIPT_STANDARD # in Super-Linter
|
31
|
+
- JSX_ESLINT
|
32
|
+
- KOTLIN_DETEKT
|
33
|
+
- KOTLIN_KTLINT # in Super-Linter
|
34
|
+
# - LUA_LUACHECK # in Super-Linter
|
35
|
+
# - LUA_SELENE
|
36
|
+
# - LUA_STYLUA
|
37
|
+
- MAKEFILE_CHECKMAKE
|
38
|
+
# - PERL_PERLCRITIC # in Super-Linter
|
39
|
+
# - PHP_BUILTIN
|
40
|
+
# - PHP_PHPCS # in Super-Linter
|
41
|
+
# - PHP_PHPCSFIXER
|
42
|
+
# - PHP_PHPLINT # in Super-Linter
|
43
|
+
# - PHP_PHPSTAN # in Super-Linter
|
44
|
+
# - PHP_PSALM # in Super-Linter
|
45
|
+
# - POWERSHELL_POWERSHELL
|
46
|
+
# - POWERSHELL_POWERSHELL_FORMATTER
|
47
|
+
- PYTHON_BANDIT
|
48
|
+
- PYTHON_BLACK # in Super-Linter
|
49
|
+
- PYTHON_FLAKE8 # in Super-Linter
|
50
|
+
- PYTHON_ISORT # in Super-Linter
|
51
|
+
- PYTHON_MYPY
|
52
|
+
- PYTHON_PYLINT # in Super-Linter
|
53
|
+
- PYTHON_PYRIGHT
|
54
|
+
- PYTHON_RUFF
|
55
|
+
- R_LINTR # in Super-Linter
|
56
|
+
# - RAKU_RAKU # in Super-Linter
|
57
|
+
# - RUBY_RUBOCOP # in Super-Linter
|
58
|
+
- RUST_CLIPPY # in Super-Linter
|
59
|
+
# - SALESFORCE_LIGHTNING_FLOW_SCANNER
|
60
|
+
# - SALESFORCE_SFDX_SCANNER_APEX
|
61
|
+
# - SALESFORCE_SFDX_SCANNER_AURA
|
62
|
+
# - SALESFORCE_SFDX_SCANNER_LWC
|
63
|
+
- SCALA_SCALAFIX
|
64
|
+
- SQL_SQLFLUFF # in Super-Linter
|
65
|
+
- SQL_TSQLLINT
|
66
|
+
- SWIFT_SWIFTLINT
|
67
|
+
- TSX_ESLINT
|
68
|
+
- TYPESCRIPT_ES # in Super-Linter
|
69
|
+
# - TYPESCRIPT_PRETTIER
|
70
|
+
- TYPESCRIPT_STANDARD # in Super-Linter
|
71
|
+
# - VBDOTNET_DOTNET_FORMAT
|
72
|
+
|
73
|
+
### Formats
|
74
|
+
- CSS_STYLELINT # in Super-Linter
|
75
|
+
- ENV_DOTENV_LINTER # in Super-Linter
|
76
|
+
# - GRAPHQL_GRAPHQL_SCHEMA_LINTER
|
77
|
+
# - HTML_DJLINT # Refuses to see config file
|
78
|
+
- HTML_HTMLHINT # in Super-Linter
|
79
|
+
- JSON_ESLINT_PLUGIN_JSONC # in Super-Linter
|
80
|
+
- JSON_JSONLINT
|
81
|
+
- JSON_NPM_PACKAGE_JSON_LINT
|
82
|
+
# - JSON_PRETTIER
|
83
|
+
- JSON_V8R
|
84
|
+
# - LATEX_CHKTEX # in Super-Linter
|
85
|
+
- MARKDOWN_MARKDOWNLINT # in Super-Linter
|
86
|
+
- MARKDOWN_MARKDOWN_LINK_CHECK
|
87
|
+
- MARKDOWN_MARKDOWN_TABLE_FORMATTER
|
88
|
+
- MARKDOWN_REMARK_LINT
|
89
|
+
# - PROTOBUF_PROTOLINT # in Super-Linter
|
90
|
+
# - RST_RSTCHECK
|
91
|
+
# - RST_RSTFMT
|
92
|
+
# - RST_RST_LINT
|
93
|
+
- XML_XMLLINT # in Super-Linter
|
94
|
+
# - YAML_PRETTIER
|
95
|
+
- YAML_V8R
|
96
|
+
- YAML_YAMLLINT # in Super-Linter
|
97
|
+
|
98
|
+
### Tooling
|
99
|
+
- ACTION_ACTIONLINT # in Super-Linter
|
100
|
+
- ANSIBLE_ANSIBLE_LINT # in Super-Linter
|
101
|
+
- API_SPECTRAL
|
102
|
+
- ARM_ARM_TTK # in Super-Linter
|
103
|
+
# - BICEP_BICEP_LINTER
|
104
|
+
- CLOUDFORMATION_CFN_LINT # in Super-Linter
|
105
|
+
- DOCKERFILE_HADOLINT # in Super-Linter
|
106
|
+
- EDITORCONFIG_EDITORCONFIG_CHECKER # in Super-Linter
|
107
|
+
# - GHERKIN_GHERKIN_LINT # in Super-Linter
|
108
|
+
- KUBERNETES_HELM
|
109
|
+
- KUBERNETES_KUBECONFORM
|
110
|
+
- KUBERNETES_KUBESCAPE
|
111
|
+
- PUPPET_PUPPET_LINT
|
112
|
+
# - SNAKEMAKE_LINT # in Super-Linter
|
113
|
+
# - SNAKEMAKE_SNAKEFMT # in Super-Linter
|
114
|
+
# - TEKTON_TEKTON_LINT # in Super-Linter
|
115
|
+
- TERRAFORM_TERRAFORM_FMT # in Super-Linter
|
116
|
+
- TERRAFORM_TERRAGRUNT # in Super-Linter
|
117
|
+
- TERRAFORM_TERRASCAN # in Super-Linter
|
118
|
+
- TERRAFORM_TFLINT # in Super-Linter
|
119
|
+
|
120
|
+
### Code quality checkers
|
121
|
+
- COPYPASTE_JSCPD # in Super-Linter
|
122
|
+
- REPOSITORY_CHECKOV
|
123
|
+
- REPOSITORY_DEVSKIM
|
124
|
+
- REPOSITORY_DUSTILOCK
|
125
|
+
- REPOSITORY_GIT_DIFF
|
126
|
+
- REPOSITORY_GITLEAKS # in Super-Linter
|
127
|
+
- REPOSITORY_GRYPE
|
128
|
+
- REPOSITORY_KICS
|
129
|
+
- REPOSITORY_LS_LINT
|
130
|
+
- REPOSITORY_SECRETLINT
|
131
|
+
- REPOSITORY_SEMGREP
|
132
|
+
- REPOSITORY_SYFT
|
133
|
+
- REPOSITORY_TRIVY
|
134
|
+
- REPOSITORY_TRIVY_SBOM
|
135
|
+
- REPOSITORY_TRUFFLEHOG
|
136
|
+
# - SPELL_CSPELL
|
137
|
+
- SPELL_LYCHEE
|
138
|
+
- SPELL_PROSELINT
|
139
|
+
- SPELL_VALE
|
140
|
+
|
141
|
+
SHOW_ELAPSED_TIME: false
|
142
|
+
FILEIO_REPORTER: false
|
143
|
+
FAIL_IF_MISSING_LINTER_IN_FLAVOR: true
|
144
|
+
# DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect
|
145
|
+
# errors but not block CI to pass
|
data/.rubocop
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--config .github/linters/rubocop_defaults.yml
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
All notable changes to this project will be documented in this file.
|
4
|
+
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
7
|
+
|
8
|
+
## [Unreleased]
|
9
|
+
|
10
|
+
## [1.0.0] - 2025-01-24
|
11
|
+
|
12
|
+
### Added
|
13
|
+
|
14
|
+
- Moved the generator out of way_of_working v1 into this plugin
|
15
|
+
- Added a Github audit rule to check for the changelog
|
16
|
+
|
17
|
+
[unreleased]: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/compare/v1.0.0...HEAD
|
18
|
+
[1.0.0]: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/releases/tag/v1.0.0
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,134 @@
|
|
1
|
+
<!--alex disable sex sexual-->
|
2
|
+
# Contributor Covenant Code of Conduct
|
3
|
+
|
4
|
+
## Our Pledge
|
5
|
+
|
6
|
+
We as members, contributors, and leaders pledge to make participation in our
|
7
|
+
community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
9
|
+
identity and expression, level of experience, education, socio-economic status,
|
10
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
11
|
+
identity and orientation.
|
12
|
+
|
13
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
14
|
+
diverse, inclusive, and healthy community.
|
15
|
+
|
16
|
+
## Our Standards
|
17
|
+
|
18
|
+
Examples of behavior that contributes to a positive environment for our
|
19
|
+
community include:
|
20
|
+
|
21
|
+
* Demonstrating empathy and kindness toward other people
|
22
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
23
|
+
* Giving and gracefully accepting constructive feedback
|
24
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
25
|
+
and learning from the experience
|
26
|
+
* Focusing on what is best not only for us as individuals, but for the overall
|
27
|
+
community
|
28
|
+
|
29
|
+
Examples of unacceptable behavior include:
|
30
|
+
|
31
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
32
|
+
any kind
|
33
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
34
|
+
* Public or private harassment
|
35
|
+
* Publishing others' private information, such as a physical or email address,
|
36
|
+
without their explicit permission
|
37
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
38
|
+
professional setting
|
39
|
+
|
40
|
+
## Enforcement Responsibilities
|
41
|
+
|
42
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
43
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
44
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
45
|
+
or harmful.
|
46
|
+
|
47
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
48
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
49
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
50
|
+
decisions when appropriate.
|
51
|
+
|
52
|
+
## Scope
|
53
|
+
|
54
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
55
|
+
an individual is officially representing the community in public spaces.
|
56
|
+
Examples of representing our community include using an official e-mail address,
|
57
|
+
posting via an official social media account, or acting as an appointed
|
58
|
+
representative at an online or offline event.
|
59
|
+
|
60
|
+
## Enforcement
|
61
|
+
|
62
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
63
|
+
reported to the community leaders responsible for enforcement at
|
64
|
+
<report.complaints@healthdatainsight.org.uk>.
|
65
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
66
|
+
|
67
|
+
All community leaders are obligated to respect the privacy and security of the
|
68
|
+
reporter of any incident.
|
69
|
+
|
70
|
+
## Enforcement Guidelines
|
71
|
+
|
72
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
73
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
74
|
+
|
75
|
+
### 1. Correction
|
76
|
+
|
77
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
78
|
+
unprofessional or unwelcome in the community.
|
79
|
+
|
80
|
+
**Consequence**: A private, written warning from community leaders, providing
|
81
|
+
clarity around the nature of the violation and an explanation of why the
|
82
|
+
behavior was inappropriate. A public apology may be requested.
|
83
|
+
|
84
|
+
### 2. Warning
|
85
|
+
|
86
|
+
**Community Impact**: A violation through a single incident or series of
|
87
|
+
actions.
|
88
|
+
|
89
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
90
|
+
interaction with the people involved, including unsolicited interaction with
|
91
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
92
|
+
includes avoiding interactions in community spaces as well as external channels
|
93
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
94
|
+
ban.
|
95
|
+
|
96
|
+
### 3. Temporary Ban
|
97
|
+
|
98
|
+
**Community Impact**: A serious violation of community standards, including
|
99
|
+
sustained inappropriate behavior.
|
100
|
+
|
101
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
102
|
+
communication with the community for a specified period of time. No public or
|
103
|
+
private interaction with the people involved, including unsolicited interaction
|
104
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
105
|
+
Violating these terms may lead to a permanent ban.
|
106
|
+
|
107
|
+
### 4. Permanent Ban
|
108
|
+
|
109
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
110
|
+
standards, including sustained inappropriate behavior, harassment of an
|
111
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
112
|
+
|
113
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
114
|
+
community.
|
115
|
+
|
116
|
+
## Attribution
|
117
|
+
|
118
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
119
|
+
version 2.1, available at
|
120
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
121
|
+
|
122
|
+
Community Impact Guidelines were inspired by
|
123
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
124
|
+
|
125
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
126
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
127
|
+
[https://www.contributor-covenant.org/translations][translations].
|
128
|
+
|
129
|
+
[homepage]: https://www.contributor-covenant.org
|
130
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
131
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
132
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
133
|
+
[translations]: https://www.contributor-covenant.org/translations
|
134
|
+
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2024 Health Data Insight CIC
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
# WayOfWorking::CodeOfConduct::ContributorCovenant
|
2
|
+
|
3
|
+
<!-- Way of Working: Main Badge Holder Start -->
|
4
|
+
![Way of Working Badge](https://img.shields.io/badge/Way_of_Working-v2.0.1-%238169e3?labelColor=black)
|
5
|
+
<!-- Way of Working: Additional Badge Holder Start -->
|
6
|
+
<!-- Way of Working: Badge Holder End -->
|
7
|
+
|
8
|
+
This is a plugin for the [Way of Working](https://github.com/HealthDataInsight/way_of_working) framework. It uses the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1
|
9
|
+
|
10
|
+
Using the Contributor Covenant Code of Conduct benefits any community or project by setting clear expectations for acceptable behaviour and creating a safer and more inclusive environment for everyone involved. The Code of Conduct establishes guidelines for respectful communication and conduct and consequences for inappropriate behaviour.
|
11
|
+
|
12
|
+
## Installation
|
13
|
+
|
14
|
+
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
|
15
|
+
|
16
|
+
Install the gem and add to the application's Gemfile by executing:
|
17
|
+
|
18
|
+
```bash
|
19
|
+
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
|
20
|
+
```
|
21
|
+
|
22
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
23
|
+
|
24
|
+
```bash
|
25
|
+
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
|
26
|
+
```
|
27
|
+
|
28
|
+
## Usage
|
29
|
+
|
30
|
+
To add a [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1 to your project, use the following at the command line:
|
31
|
+
|
32
|
+
```bash
|
33
|
+
way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
|
34
|
+
```
|
35
|
+
|
36
|
+
You will need to enter a contact method, usually an email address. Please thoroughly read the [enforcement guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines) section of the code and discuss the implications of adopting the code of conduct.
|
37
|
+
|
38
|
+
## Development
|
39
|
+
|
40
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
41
|
+
|
42
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
43
|
+
|
44
|
+
## Contributing
|
45
|
+
|
46
|
+
Bug reports and pull requests are welcome on GitHub at <https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant>.
|
47
|
+
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/blob/main/CODE_OF_CONDUCT.md).
|
48
|
+
|
49
|
+
## License
|
50
|
+
|
51
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
52
|
+
|
53
|
+
## Code of Conduct
|
54
|
+
|
55
|
+
Everyone interacting in the way_of_working-code_of_conduct-contributor_covenant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/blob/main/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'bundler/gem_tasks'
|
4
|
+
require 'rake/testtask'
|
5
|
+
require 'way_of_working/tasks'
|
6
|
+
|
7
|
+
Rake::TestTask.new(:test) do |t|
|
8
|
+
t.libs << 'lib'
|
9
|
+
t.libs << 'test'
|
10
|
+
t.test_files = FileList['test/**/*_test.rb']
|
11
|
+
t.verbose = false
|
12
|
+
t.warning = false
|
13
|
+
end
|
14
|
+
|
15
|
+
desc 'Run tests'
|
16
|
+
task default: :test
|
data/code_safety.yml
ADDED
@@ -0,0 +1,146 @@
|
|
1
|
+
---
|
2
|
+
file safety:
|
3
|
+
".alexignore":
|
4
|
+
comments:
|
5
|
+
reviewed_by: shilpigoeldev
|
6
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
7
|
+
".alexrc":
|
8
|
+
comments:
|
9
|
+
reviewed_by: shilpigoeldev
|
10
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
11
|
+
".github/linters/.markdown-link-check.json":
|
12
|
+
comments:
|
13
|
+
reviewed_by: shilpigoeldev
|
14
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
15
|
+
".github/linters/rubocop_defaults.yml":
|
16
|
+
comments:
|
17
|
+
reviewed_by: shilpigoeldev
|
18
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
19
|
+
".github/workflows/inclusive-language.yml":
|
20
|
+
comments:
|
21
|
+
reviewed_by: shilpigoeldev
|
22
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
23
|
+
".github/workflows/main.yml":
|
24
|
+
comments:
|
25
|
+
reviewed_by: shilpigoeldev
|
26
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
27
|
+
".github/workflows/mega-linter.yml":
|
28
|
+
comments:
|
29
|
+
reviewed_by: shilpigoeldev
|
30
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
31
|
+
".gitignore":
|
32
|
+
comments:
|
33
|
+
reviewed_by: shilpigoeldev
|
34
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
35
|
+
".mega-linter.yml":
|
36
|
+
comments:
|
37
|
+
reviewed_by: shilpigoeldev
|
38
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
39
|
+
".rubocop":
|
40
|
+
comments:
|
41
|
+
reviewed_by: shilpigoeldev
|
42
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
43
|
+
CHANGELOG.md:
|
44
|
+
comments:
|
45
|
+
reviewed_by: shilpigoeldev
|
46
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
47
|
+
CODE_OF_CONDUCT.md:
|
48
|
+
comments:
|
49
|
+
reviewed_by: shilpigoeldev
|
50
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
51
|
+
Gemfile:
|
52
|
+
comments:
|
53
|
+
reviewed_by: shilpigoeldev
|
54
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
55
|
+
Gemfile.lock:
|
56
|
+
comments:
|
57
|
+
reviewed_by: shilpigoeldev
|
58
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
59
|
+
LICENSE.txt:
|
60
|
+
comments:
|
61
|
+
reviewed_by: shilpigoeldev
|
62
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
63
|
+
README.md:
|
64
|
+
comments:
|
65
|
+
reviewed_by: shilpigoeldev
|
66
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
67
|
+
Rakefile:
|
68
|
+
comments:
|
69
|
+
reviewed_by: shilpigoeldev
|
70
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
71
|
+
bin/console:
|
72
|
+
comments:
|
73
|
+
reviewed_by: shilpigoeldev
|
74
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
75
|
+
bin/setup:
|
76
|
+
comments:
|
77
|
+
reviewed_by: shilpigoeldev
|
78
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
79
|
+
docs/way_of_working/code-of-conduct.md:
|
80
|
+
comments:
|
81
|
+
reviewed_by: shilpigoeldev
|
82
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
83
|
+
docs/way_of_working/inclusive-language.md:
|
84
|
+
comments:
|
85
|
+
reviewed_by: shilpigoeldev
|
86
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
87
|
+
lib/way_of_working/code_of_conduct/contributor_covenant.rb:
|
88
|
+
comments:
|
89
|
+
reviewed_by: shilpigoeldev
|
90
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
91
|
+
lib/way_of_working/code_of_conduct/contributor_covenant/generators/init.rb:
|
92
|
+
comments:
|
93
|
+
reviewed_by: shilpigoeldev
|
94
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
95
|
+
lib/way_of_working/code_of_conduct/contributor_covenant/github_audit_rule.rb:
|
96
|
+
comments:
|
97
|
+
reviewed_by: shilpigoeldev
|
98
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
99
|
+
lib/way_of_working/code_of_conduct/contributor_covenant/paths.rb:
|
100
|
+
comments:
|
101
|
+
reviewed_by: shilpigoeldev
|
102
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
103
|
+
lib/way_of_working/code_of_conduct/contributor_covenant/plugin.rb:
|
104
|
+
comments:
|
105
|
+
reviewed_by: shilpigoeldev
|
106
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
107
|
+
lib/way_of_working/code_of_conduct/contributor_covenant/templates/CODE_OF_CONDUCT.md.tt:
|
108
|
+
comments:
|
109
|
+
reviewed_by: shilpigoeldev
|
110
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
111
|
+
lib/way_of_working/code_of_conduct/contributor_covenant/templates/docs/way_of_working/code-of-conduct.md:
|
112
|
+
comments:
|
113
|
+
reviewed_by: shilpigoeldev
|
114
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
115
|
+
lib/way_of_working/code_of_conduct/contributor_covenant/version.rb:
|
116
|
+
comments:
|
117
|
+
reviewed_by: shilpigoeldev
|
118
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
119
|
+
test/test_helper.rb:
|
120
|
+
comments:
|
121
|
+
reviewed_by: shilpigoeldev
|
122
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
123
|
+
test/way_of_working/audit_github_stub_classes.rb:
|
124
|
+
comments:
|
125
|
+
reviewed_by: shilpigoeldev
|
126
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
127
|
+
test/way_of_working/code_of_conduct/contributor_covenant/generators/init_test.rb:
|
128
|
+
comments:
|
129
|
+
reviewed_by: shilpigoeldev
|
130
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
131
|
+
test/way_of_working/code_of_conduct/contributor_covenant/github_audit_rule_test.rb:
|
132
|
+
comments:
|
133
|
+
reviewed_by: shilpigoeldev
|
134
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
135
|
+
test/way_of_working/code_of_conduct/contributor_covenant/zeitwerk_loader_test.rb:
|
136
|
+
comments:
|
137
|
+
reviewed_by: shilpigoeldev
|
138
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
139
|
+
test/way_of_working/code_of_conduct/contributor_covenant_test.rb:
|
140
|
+
comments:
|
141
|
+
reviewed_by: shilpigoeldev
|
142
|
+
safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
|
143
|
+
way_of_working-code_of_conduct-contributor_covenant.gemspec:
|
144
|
+
comments:
|
145
|
+
reviewed_by: shilpigoeldev
|
146
|
+
safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
|
@@ -0,0 +1,35 @@
|
|
1
|
+
---
|
2
|
+
layout: page
|
3
|
+
---
|
4
|
+
# Code of Conduct
|
5
|
+
|
6
|
+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
|
7
|
+
|
8
|
+
We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1
|
9
|
+
|
10
|
+
Using the Contributor Covenant Code of Conduct benefits any community or project by setting clear expectations for acceptable behaviour and creating a safer and more inclusive environment for everyone involved.
|
11
|
+
The Code of Conduct establishes guidelines for respectful communication and conduct and consequences for inappropriate behaviour. By adhering to these guidelines, community members can build trust and mutual respect, which fosters a more collaborative and productive environment.
|
12
|
+
|
13
|
+
The Contributor Covenant is specifically designed to promote diversity and inclusion within communities and projects. It includes provisions to prevent discrimination and harassment based on factors such as race, gender, sexual orientation, and ability. By adopting and enforcing the Code of Conduct, communities can create a more welcoming and supportive environment for underrepresented groups.
|
14
|
+
|
15
|
+
In addition to promoting a positive and inclusive environment, the Contributor Covenant can help prevent conflicts and misunderstandings by providing a clear set of expectations for behaviour, reducing the likelihood of interpersonal conflicts and creating a more harmonious community.
|
16
|
+
Projects and communities can establish a strong foundation for healthy collaboration and growth using the Contributor Covenant Code of Conduct.
|
17
|
+
|
18
|
+
{: .important }
|
19
|
+
Adopting the Contributor Covenant Code of Conduct involves more than only adding a `CODE_OF_CONDUCT.md` file to the root of your project.
|
20
|
+
Please thoroughly read the [enforcement guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines) section of the code and discuss the implications of adopting the code of conduct with your team.
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
### Adding the Code of Conduct to your project
|
25
|
+
|
26
|
+
To add a [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1 to your project, use the following at the command line:
|
27
|
+
|
28
|
+
```bash
|
29
|
+
way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
|
30
|
+
```
|
31
|
+
|
32
|
+
You will need to enter a contact method, usually an email address.
|
33
|
+
|
34
|
+
{: .note }
|
35
|
+
We recommend that you use the HDI code of conduct email address as the contact method.
|
@@ -0,0 +1,28 @@
|
|
1
|
+
---
|
2
|
+
layout: page
|
3
|
+
---
|
4
|
+
|
5
|
+
# Inclusive Language
|
6
|
+
|
7
|
+
We have adopted [alex](https://alexjs.com) for automated testing of inclusive language.
|
8
|
+
|
9
|
+
Using insensitive and inconsiderate language can cause harm to others, create barriers to communication, and damage relationships. It can make people feel excluded, disrespected, and devalued and may perpetuate negative stereotypes and biases. When we use insensitive or offensive language, we undermine our ability to connect with others and build trust.
|
10
|
+
|
11
|
+
Therefore, it is essential to be mindful of the impact of our words and to choose language that is respectful, inclusive, and considerate of others. Doing so can create a more welcoming and inclusive environment for everyone, fostering greater understanding, empathy, and cooperation.
|
12
|
+
|
13
|
+
To quote from the alex README:
|
14
|
+
|
15
|
+
> No automated tool can replace studying inclusive communication and listening to the lived experiences of others. **An error from alex can be an invitation to learn more**.
|
16
|
+
|
17
|
+
{: .important }
|
18
|
+
Please take the opportunity to read some of the [further reading](https://github.com/get-alex/alex#further-reading) they reference and click on the links against individual warnings when they appear.
|
19
|
+
|
20
|
+
## Usage
|
21
|
+
|
22
|
+
To add alex to your project, run the following at the command line:
|
23
|
+
|
24
|
+
way_of_working init inclusive_language
|
25
|
+
|
26
|
+
to run alex in your project, run:
|
27
|
+
|
28
|
+
way_of_working exec inclusive_language
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'way_of_working/paths'
|
4
|
+
|
5
|
+
module WayOfWorking
|
6
|
+
module CodeOfConduct
|
7
|
+
module ContributorCovenant
|
8
|
+
module Generators
|
9
|
+
# This class fetches the CODE_OF_CONDUCT.md and inserts the contact method
|
10
|
+
class Init < Thor::Group
|
11
|
+
include Thor::Actions
|
12
|
+
|
13
|
+
source_root ::WayOfWorking::CodeOfConduct::ContributorCovenant.source_root
|
14
|
+
|
15
|
+
class_option :contact_method, required: true
|
16
|
+
|
17
|
+
# Use this method to update the cached template when required
|
18
|
+
# def download_and_save_code_of_conduct_template
|
19
|
+
# code_of_conduct_file = 'lib/way_of_working/templates/CODE_OF_CONDUCT.md.tt'
|
20
|
+
|
21
|
+
# get 'https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md',
|
22
|
+
# code_of_conduct_file
|
23
|
+
# gsub_file code_of_conduct_file, '[INSERT CONTACT METHOD]',
|
24
|
+
# "<<%= options['contact_method'] %>>"
|
25
|
+
# end
|
26
|
+
|
27
|
+
def add_code_of_conduct_to_project
|
28
|
+
template 'CODE_OF_CONDUCT.md'
|
29
|
+
end
|
30
|
+
|
31
|
+
def add_way_of_working_documentation
|
32
|
+
copy_file 'docs/way_of_working/code-of-conduct.md'
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'way_of_working/audit/github/rules/base'
|
4
|
+
|
5
|
+
module WayOfWorking
|
6
|
+
module CodeOfConduct
|
7
|
+
# The namespace for this plugin
|
8
|
+
module ContributorCovenant
|
9
|
+
# This rule checks for the MegaLinter workflow action and README badge.
|
10
|
+
class GithubAuditRule < ::WayOfWorking::Audit::Github::Rules::Base
|
11
|
+
def validate
|
12
|
+
@errors << 'No Contributor Covenant code of conduct found' unless code_of_conduct?
|
13
|
+
end
|
14
|
+
|
15
|
+
private
|
16
|
+
|
17
|
+
def code_of_conduct?
|
18
|
+
response = @client.contents(@repo_name, path: 'CODE_OF_CONDUCT.md')
|
19
|
+
decoded_content = Base64.decode64(response.content)
|
20
|
+
|
21
|
+
decoded_content.include?('# Contributor Covenant Code of Conduct')
|
22
|
+
rescue Octokit::NotFound
|
23
|
+
false
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
::WayOfWorking::Audit::Github::Rules::Registry.register(
|
28
|
+
GithubAuditRule, 'Contributor Covenant Code Of Conduct'
|
29
|
+
)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'pathname'
|
4
|
+
|
5
|
+
module WayOfWorking
|
6
|
+
module CodeOfConduct
|
7
|
+
# Mixin that provides a couple of pathname convenience methods
|
8
|
+
module ContributorCovenant
|
9
|
+
class << self
|
10
|
+
def root
|
11
|
+
Pathname.new(File.expand_path('../../../..', __dir__))
|
12
|
+
end
|
13
|
+
|
14
|
+
def source_root
|
15
|
+
root.join('lib', 'way_of_working', 'code_of_conduct', 'contributor_covenant', 'templates')
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'way_of_working/code_of_conduct/contributor_covenant'
|
@@ -0,0 +1,134 @@
|
|
1
|
+
<!--alex disable sex sexual-->
|
2
|
+
# Contributor Covenant Code of Conduct
|
3
|
+
|
4
|
+
## Our Pledge
|
5
|
+
|
6
|
+
We as members, contributors, and leaders pledge to make participation in our
|
7
|
+
community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
9
|
+
identity and expression, level of experience, education, socio-economic status,
|
10
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
11
|
+
identity and orientation.
|
12
|
+
|
13
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
14
|
+
diverse, inclusive, and healthy community.
|
15
|
+
|
16
|
+
## Our Standards
|
17
|
+
|
18
|
+
Examples of behavior that contributes to a positive environment for our
|
19
|
+
community include:
|
20
|
+
|
21
|
+
* Demonstrating empathy and kindness toward other people
|
22
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
23
|
+
* Giving and gracefully accepting constructive feedback
|
24
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
25
|
+
and learning from the experience
|
26
|
+
* Focusing on what is best not only for us as individuals, but for the overall
|
27
|
+
community
|
28
|
+
|
29
|
+
Examples of unacceptable behavior include:
|
30
|
+
|
31
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
32
|
+
any kind
|
33
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
34
|
+
* Public or private harassment
|
35
|
+
* Publishing others' private information, such as a physical or email address,
|
36
|
+
without their explicit permission
|
37
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
38
|
+
professional setting
|
39
|
+
|
40
|
+
## Enforcement Responsibilities
|
41
|
+
|
42
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
43
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
44
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
45
|
+
or harmful.
|
46
|
+
|
47
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
48
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
49
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
50
|
+
decisions when appropriate.
|
51
|
+
|
52
|
+
## Scope
|
53
|
+
|
54
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
55
|
+
an individual is officially representing the community in public spaces.
|
56
|
+
Examples of representing our community include using an official e-mail address,
|
57
|
+
posting via an official social media account, or acting as an appointed
|
58
|
+
representative at an online or offline event.
|
59
|
+
|
60
|
+
## Enforcement
|
61
|
+
|
62
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
63
|
+
reported to the community leaders responsible for enforcement at
|
64
|
+
<<%= options['contact_method'] %>>.
|
65
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
66
|
+
|
67
|
+
All community leaders are obligated to respect the privacy and security of the
|
68
|
+
reporter of any incident.
|
69
|
+
|
70
|
+
## Enforcement Guidelines
|
71
|
+
|
72
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
73
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
74
|
+
|
75
|
+
### 1. Correction
|
76
|
+
|
77
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
78
|
+
unprofessional or unwelcome in the community.
|
79
|
+
|
80
|
+
**Consequence**: A private, written warning from community leaders, providing
|
81
|
+
clarity around the nature of the violation and an explanation of why the
|
82
|
+
behavior was inappropriate. A public apology may be requested.
|
83
|
+
|
84
|
+
### 2. Warning
|
85
|
+
|
86
|
+
**Community Impact**: A violation through a single incident or series of
|
87
|
+
actions.
|
88
|
+
|
89
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
90
|
+
interaction with the people involved, including unsolicited interaction with
|
91
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
92
|
+
includes avoiding interactions in community spaces as well as external channels
|
93
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
94
|
+
ban.
|
95
|
+
|
96
|
+
### 3. Temporary Ban
|
97
|
+
|
98
|
+
**Community Impact**: A serious violation of community standards, including
|
99
|
+
sustained inappropriate behavior.
|
100
|
+
|
101
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
102
|
+
communication with the community for a specified period of time. No public or
|
103
|
+
private interaction with the people involved, including unsolicited interaction
|
104
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
105
|
+
Violating these terms may lead to a permanent ban.
|
106
|
+
|
107
|
+
### 4. Permanent Ban
|
108
|
+
|
109
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
110
|
+
standards, including sustained inappropriate behavior, harassment of an
|
111
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
112
|
+
|
113
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
114
|
+
community.
|
115
|
+
|
116
|
+
## Attribution
|
117
|
+
|
118
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
119
|
+
version 2.1, available at
|
120
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
121
|
+
|
122
|
+
Community Impact Guidelines were inspired by
|
123
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
124
|
+
|
125
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
126
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
127
|
+
[https://www.contributor-covenant.org/translations][translations].
|
128
|
+
|
129
|
+
[homepage]: https://www.contributor-covenant.org
|
130
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
131
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
132
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
133
|
+
[translations]: https://www.contributor-covenant.org/translations
|
134
|
+
|
@@ -0,0 +1,35 @@
|
|
1
|
+
---
|
2
|
+
layout: page
|
3
|
+
---
|
4
|
+
# Code of Conduct
|
5
|
+
|
6
|
+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
|
7
|
+
|
8
|
+
We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1
|
9
|
+
|
10
|
+
Using the Contributor Covenant Code of Conduct benefits any community or project by setting clear expectations for acceptable behaviour and creating a safer and more inclusive environment for everyone involved.
|
11
|
+
The Code of Conduct establishes guidelines for respectful communication and conduct and consequences for inappropriate behaviour. By adhering to these guidelines, community members can build trust and mutual respect, which fosters a more collaborative and productive environment.
|
12
|
+
|
13
|
+
The Contributor Covenant is specifically designed to promote diversity and inclusion within communities and projects. It includes provisions to prevent discrimination and harassment based on factors such as race, gender, sexual orientation, and ability. By adopting and enforcing the Code of Conduct, communities can create a more welcoming and supportive environment for underrepresented groups.
|
14
|
+
|
15
|
+
In addition to promoting a positive and inclusive environment, the Contributor Covenant can help prevent conflicts and misunderstandings by providing a clear set of expectations for behaviour, reducing the likelihood of interpersonal conflicts and creating a more harmonious community.
|
16
|
+
Projects and communities can establish a strong foundation for healthy collaboration and growth using the Contributor Covenant Code of Conduct.
|
17
|
+
|
18
|
+
{: .important }
|
19
|
+
Adopting the Contributor Covenant Code of Conduct involves more than only adding a `CODE_OF_CONDUCT.md` file to the root of your project.
|
20
|
+
Please thoroughly read the [enforcement guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines) section of the code and discuss the implications of adopting the code of conduct with your team.
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
### Adding the Code of Conduct to your project
|
25
|
+
|
26
|
+
To add a [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1 to your project, use the following at the command line:
|
27
|
+
|
28
|
+
```bash
|
29
|
+
way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
|
30
|
+
```
|
31
|
+
|
32
|
+
You will need to enter a contact method, usually an email address.
|
33
|
+
|
34
|
+
{: .note }
|
35
|
+
We recommend that you use the HDI code of conduct email address as the contact method.
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'way_of_working'
|
4
|
+
require_relative 'contributor_covenant/paths'
|
5
|
+
require 'zeitwerk'
|
6
|
+
|
7
|
+
# If way_of_working-audit-github is used we can add a rule
|
8
|
+
begin
|
9
|
+
require 'way_of_working/audit/github/rules/registry'
|
10
|
+
require_relative 'contributor_covenant/github_audit_rule'
|
11
|
+
rescue LoadError # rubocop:disable Lint/SuppressedException
|
12
|
+
end
|
13
|
+
|
14
|
+
loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::CodeOfConduct)
|
15
|
+
loader.ignore("#{__dir__}/contributor_covenant/plugin.rb")
|
16
|
+
loader.setup
|
17
|
+
|
18
|
+
module WayOfWorking
|
19
|
+
module CodeOfConduct
|
20
|
+
module ContributorCovenant
|
21
|
+
class Error < StandardError; end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
module SubCommands
|
26
|
+
# This reopens the "way_of_working init" sub command
|
27
|
+
class Init
|
28
|
+
register(CodeOfConduct::ContributorCovenant::Generators::Init, 'code_of_conduct',
|
29
|
+
'code_of_conduct --contact-method [CONTACT METHOD]',
|
30
|
+
<<~LONGDESC)
|
31
|
+
Description:
|
32
|
+
This adds the Contributor Covenant v2.1 code of conduct to the project
|
33
|
+
|
34
|
+
Example:
|
35
|
+
way_of_working init code_of_conduct --contact-method "foo@bar.com"
|
36
|
+
|
37
|
+
This will create:
|
38
|
+
CODE_OF_CONDUCT.md
|
39
|
+
LONGDESC
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
metadata
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: way_of_working-code_of_conduct-contributor_covenant
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Tim Gentry
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2025-01-24 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: way_of_working
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '2.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '2.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: zeitwerk
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 2.6.18
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 2.6.18
|
41
|
+
description:
|
42
|
+
email:
|
43
|
+
- 52189+timgentry@users.noreply.github.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- ".alexignore"
|
49
|
+
- ".alexrc"
|
50
|
+
- ".mega-linter.yml"
|
51
|
+
- ".rubocop"
|
52
|
+
- CHANGELOG.md
|
53
|
+
- CODE_OF_CONDUCT.md
|
54
|
+
- LICENSE.txt
|
55
|
+
- README.md
|
56
|
+
- Rakefile
|
57
|
+
- code_safety.yml
|
58
|
+
- docs/way_of_working/code-of-conduct.md
|
59
|
+
- docs/way_of_working/inclusive-language.md
|
60
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant.rb
|
61
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant/generators/init.rb
|
62
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant/github_audit_rule.rb
|
63
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant/paths.rb
|
64
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant/plugin.rb
|
65
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant/templates/CODE_OF_CONDUCT.md.tt
|
66
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant/templates/docs/way_of_working/code-of-conduct.md
|
67
|
+
- lib/way_of_working/code_of_conduct/contributor_covenant/version.rb
|
68
|
+
homepage: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant
|
69
|
+
licenses:
|
70
|
+
- MIT
|
71
|
+
metadata:
|
72
|
+
allowed_push_host: https://rubygems.org
|
73
|
+
rubygems_mfa_required: 'true'
|
74
|
+
homepage_uri: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant
|
75
|
+
source_code_uri: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant
|
76
|
+
changelog_uri: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/blob/main/CHANGELOG.md
|
77
|
+
post_install_message:
|
78
|
+
rdoc_options: []
|
79
|
+
require_paths:
|
80
|
+
- lib
|
81
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
82
|
+
requirements:
|
83
|
+
- - ">="
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: 3.1.0
|
86
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ">="
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
requirements: []
|
92
|
+
rubygems_version: 3.5.22
|
93
|
+
signing_key:
|
94
|
+
specification_version: 4
|
95
|
+
summary: Way of Working plugin for the Contributor Covenant Code of Conduct
|
96
|
+
test_files: []
|