way_of_working-code_of_conduct-contributor_covenant 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 359c640f6a814b70e7874c84c523d9e69dda699ee621faf3fc2b7567b9859b22
4
- data.tar.gz: 634b0f4deeb093dfa47aa1dbcbc8db47bb9768276e7f7381fecddba512dbf8be
3
+ metadata.gz: 2bdafcf45339c5235b190a7de53e65b28d86e786c79c2c85b34dad5727bfb852
4
+ data.tar.gz: dd9dc1e29101a1eeed7bf337a2598653fe20d1013e3e3d565c5737befd65a0ee
5
5
  SHA512:
6
- metadata.gz: f7b0e26934f172f0f3b9e552fb77757bd525ab905a3066311062da105d9d446161ca7b9b35e6d89cc76a75af9ad070cf4bc11310eca776874f0d89fb72235031
7
- data.tar.gz: b080012365f2c817648950f2e9b645eaf2d663be26b7d4c78f8600b9466d5dcaba75b8213ba1d6cf386c1044c926cafdc3030390d09e590e3f6db7e269dd1e2c
6
+ metadata.gz: a24d3a23f0dcfd013234e5ebf3562863e4edd693a989f93b6f04f7e5526926bf43599b5cccb0fa0946d40f574b358441b348e0233e4f54e211be7be395490571
7
+ data.tar.gz: 60b20a6d8528b96210cb8d896791b78f6300d2f6c2b9ff4d909116fab03ccb87b7fe0f7ff66df4bfba08b47599f01fd814db563498c146cf8abe9ed21344b307
data/CHANGELOG.md CHANGED
@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [1.0.1] - 2025-11-28
11
+
12
+ ### Changed
13
+
14
+ - Updated GitHub rule signatures
15
+ - Removed Zeitwerk ignore to make it happier
16
+ - Removed unnecessary inline alex ignores
17
+
18
+ ## Fixed
19
+
20
+ - The documentation is now LLM-friendly
21
+
10
22
  ## [1.0.0] - 2025-01-24
11
23
 
12
24
  ### Added
@@ -14,5 +26,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
14
26
  - Moved the generator out of way_of_working v1 into this plugin
15
27
  - Added a Github audit rule to check for the changelog
16
28
 
17
- [unreleased]: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/compare/v1.0.0...HEAD
29
+ [unreleased]: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/compare/v1.0.1...HEAD
30
+ [1.0.1]: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant/compare/v1.0.0...v1.0.1
18
31
  [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 CHANGED
@@ -1,4 +1,3 @@
1
- <!--alex disable sex sexual-->
2
1
  # Contributor Covenant Code of Conduct
3
2
 
4
3
  ## Our Pledge
data/README.md CHANGED
@@ -5,24 +5,24 @@
5
5
  <!-- Way of Working: Additional Badge Holder Start -->
6
6
  <!-- Way of Working: Badge Holder End -->
7
7
 
8
+ [![Gem Version](https://badge.fury.io/rb/way_of_working-code_of_conduct-contributor_covenant.svg)](https://badge.fury.io/rb/way_of_working-code_of_conduct-contributor_covenant)
9
+
8
10
  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
11
 
10
12
  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
13
 
12
14
  ## Installation
13
15
 
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
16
  Install the gem and add to the application's Gemfile by executing:
17
17
 
18
18
  ```bash
19
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
19
+ bundle add way_of_working-code_of_conduct-contributor_covenant
20
20
  ```
21
21
 
22
22
  If bundler is not being used to manage dependencies, install the gem by executing:
23
23
 
24
24
  ```bash
25
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
25
+ gem install way_of_working-code_of_conduct-contributor_covenant
26
26
  ```
27
27
 
28
28
  ## Usage
data/code_safety.yml CHANGED
@@ -43,11 +43,11 @@ file safety:
43
43
  CHANGELOG.md:
44
44
  comments:
45
45
  reviewed_by: shilpigoeldev
46
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
46
+ safe_revision: 403530a11025f185fe3d5675af93126bf0374789
47
47
  CODE_OF_CONDUCT.md:
48
48
  comments:
49
- reviewed_by: shilpigoeldev
50
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
49
+ reviewed_by: timgentry
50
+ safe_revision: '08b322b4214e38cbce371b73463453628acd09b9'
51
51
  Gemfile:
52
52
  comments:
53
53
  reviewed_by: shilpigoeldev
@@ -55,15 +55,15 @@ file safety:
55
55
  Gemfile.lock:
56
56
  comments:
57
57
  reviewed_by: shilpigoeldev
58
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
58
+ safe_revision: 403530a11025f185fe3d5675af93126bf0374789
59
59
  LICENSE.txt:
60
60
  comments:
61
61
  reviewed_by: shilpigoeldev
62
62
  safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
63
63
  README.md:
64
64
  comments:
65
- reviewed_by: shilpigoeldev
66
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
65
+ reviewed_by: timgentry
66
+ safe_revision: 1f964cc18e527a7354fd4a9a4911bd5e8d862cf1
67
67
  Rakefile:
68
68
  comments:
69
69
  reviewed_by: shilpigoeldev
@@ -78,16 +78,16 @@ file safety:
78
78
  safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
79
79
  docs/way_of_working/code-of-conduct.md:
80
80
  comments:
81
- reviewed_by: shilpigoeldev
82
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
81
+ reviewed_by: timgentry
82
+ safe_revision: '03587db522e42ce5d2320ca6faf2e7d72fe80a95'
83
83
  docs/way_of_working/inclusive-language.md:
84
84
  comments:
85
85
  reviewed_by: shilpigoeldev
86
86
  safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
87
87
  lib/way_of_working/code_of_conduct/contributor_covenant.rb:
88
88
  comments:
89
- reviewed_by: shilpigoeldev
90
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
89
+ reviewed_by: timgentry
90
+ safe_revision: '08b322b4214e38cbce371b73463453628acd09b9'
91
91
  lib/way_of_working/code_of_conduct/contributor_covenant/generators/init.rb:
92
92
  comments:
93
93
  reviewed_by: shilpigoeldev
@@ -102,28 +102,28 @@ file safety:
102
102
  safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
103
103
  lib/way_of_working/code_of_conduct/contributor_covenant/plugin.rb:
104
104
  comments:
105
- reviewed_by: shilpigoeldev
106
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
105
+ reviewed_by: timgentry
106
+ safe_revision: '08b322b4214e38cbce371b73463453628acd09b9'
107
107
  lib/way_of_working/code_of_conduct/contributor_covenant/templates/CODE_OF_CONDUCT.md.tt:
108
108
  comments:
109
- reviewed_by: shilpigoeldev
110
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
109
+ reviewed_by: timgentry
110
+ safe_revision: '08b322b4214e38cbce371b73463453628acd09b9'
111
111
  lib/way_of_working/code_of_conduct/contributor_covenant/templates/docs/way_of_working/code-of-conduct.md:
112
112
  comments:
113
- reviewed_by: shilpigoeldev
114
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
113
+ reviewed_by: timgentry
114
+ safe_revision: '03587db522e42ce5d2320ca6faf2e7d72fe80a95'
115
115
  lib/way_of_working/code_of_conduct/contributor_covenant/version.rb:
116
116
  comments:
117
117
  reviewed_by: shilpigoeldev
118
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
118
+ safe_revision: 403530a11025f185fe3d5675af93126bf0374789
119
119
  test/test_helper.rb:
120
120
  comments:
121
121
  reviewed_by: shilpigoeldev
122
122
  safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
123
123
  test/way_of_working/audit_github_stub_classes.rb:
124
124
  comments:
125
- reviewed_by: shilpigoeldev
126
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
125
+ reviewed_by: timgentry
126
+ safe_revision: '08b322b4214e38cbce371b73463453628acd09b9'
127
127
  test/way_of_working/code_of_conduct/contributor_covenant/generators/init_test.rb:
128
128
  comments:
129
129
  reviewed_by: shilpigoeldev
@@ -142,5 +142,5 @@ file safety:
142
142
  safe_revision: 7a8b71cc6fbe856d7e5b445b4b0de9b7a8a4f82d
143
143
  way_of_working-code_of_conduct-contributor_covenant.gemspec:
144
144
  comments:
145
- reviewed_by: shilpigoeldev
146
- safe_revision: b2c63ee5cf0f603c0a71813a04946323cc8c37a8
145
+ reviewed_by: timgentry
146
+ safe_revision: '08b322b4214e38cbce371b73463453628acd09b9'
@@ -1,35 +1,78 @@
1
1
  ---
2
2
  layout: page
3
+ status: REQUIRED
4
+ enforcement: manual
3
5
  ---
4
6
  # Code of Conduct
5
7
 
6
- [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
8
+ ## Purpose
7
9
 
8
- We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1
10
+ We adopt the [Contributor Covenant v2.1][covenant] to establish clear behavioural expectations, create safe inclusive environments, prevent discrimination/harassment, and reduce conflicts.
9
11
 
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
+ {: .important }
13
+ Adoption requires more than adding `CODE_OF_CONDUCT.md`. Please read the [enforcement guidelines][enforcement] and discuss with your team.
12
14
 
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.
15
+ ## Scope
14
16
 
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
+ Applies to all project spaces and community interactions.
17
18
 
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.
19
+ **Promotes:** Respectful communication, collaboration, inclusive language, professional conduct
21
20
 
22
- ## Usage
21
+ **Prevents:** Discrimination, harassment, unprofessional behaviour
23
22
 
24
- ### Adding the Code of Conduct to your project
23
+ ## Requirements
24
+
25
+ 1. Contact method for reports (email address)
26
+ 2. Enforcement responsibilities and process
27
+ 3. Consequences framework
28
+
29
+ {: .note }
30
+ Use HDI Code of Conduct email address as contact method.
25
31
 
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:
32
+ ## Setup
27
33
 
28
34
  ```bash
29
35
  way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
30
36
  ```
31
37
 
32
- You will need to enter a contact method, usually an email address.
38
+ ## Usage
33
39
 
34
- {: .note }
35
- We recommend that you use the HDI code of conduct email address as the contact method.
40
+ Command creates `CODE_OF_CONDUCT.md` in repository root.
41
+
42
+ **Post-setup:**
43
+
44
+ 1. Review enforcement guidelines with team
45
+ 2. Assign enforcement responsibilities
46
+ 3. Communicate adoption to contributors
47
+ 4. Link from README and CONTRIBUTING
48
+
49
+ **Enforcement process:**
50
+ Report → Review → Investigate → Apply consequence → Document
51
+
52
+ ## Enforcement
53
+
54
+ **Consequences:**
55
+
56
+ - **Warning:** First offense, minor issue
57
+ - **Temporary ban:** Sustained inappropriate behavior
58
+ - **Permanent ban:** Severe violations or repeat offenses
59
+
60
+ **Requirements:**
61
+
62
+ - Consistent enforcement by leadership
63
+ - Confidential handling, 5-day response
64
+ - Document incidents, annual review
65
+
66
+ ## Examples
67
+
68
+ **Acceptable:** Welcoming language, respect differing views, accept criticism, focus on community benefit
69
+
70
+ **Unacceptable:** Sexualized content, trolling/insults, harassment, publishing private info, unprofessional conduct
71
+
72
+ ## Resources
73
+
74
+ - [Contributor Covenant v2.1][covenant]
75
+ - [Enforcement Guidelines][enforcement]
76
+
77
+ [covenant]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
78
+ [enforcement]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines
@@ -1 +1,13 @@
1
1
  require 'way_of_working/code_of_conduct/contributor_covenant'
2
+
3
+ # Add any plug specific code here
4
+
5
+ module WayOfWorking
6
+ module CodeOfConduct
7
+ module ContributorCovenant
8
+ # This makes zeitwerk happy, which makes us happy too
9
+ module Plugin
10
+ end
11
+ end
12
+ end
13
+ end
@@ -1,4 +1,3 @@
1
- <!--alex disable sex sexual-->
2
1
  # Contributor Covenant Code of Conduct
3
2
 
4
3
  ## Our Pledge
@@ -1,35 +1,78 @@
1
1
  ---
2
2
  layout: page
3
+ status: REQUIRED
4
+ enforcement: manual
3
5
  ---
4
6
  # Code of Conduct
5
7
 
6
- [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
8
+ ## Purpose
7
9
 
8
- We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1
10
+ We adopt the [Contributor Covenant v2.1][covenant] to establish clear behavioural expectations, create safe inclusive environments, prevent discrimination/harassment, and reduce conflicts.
9
11
 
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
+ {: .important }
13
+ Adoption requires more than adding `CODE_OF_CONDUCT.md`. Please read the [enforcement guidelines][enforcement] and discuss with your team.
12
14
 
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.
15
+ ## Scope
14
16
 
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
+ Applies to all project spaces and community interactions.
17
18
 
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.
19
+ **Promotes:** Respectful communication, collaboration, inclusive language, professional conduct
21
20
 
22
- ## Usage
21
+ **Prevents:** Discrimination, harassment, unprofessional behaviour
23
22
 
24
- ### Adding the Code of Conduct to your project
23
+ ## Requirements
24
+
25
+ 1. Contact method for reports (email address)
26
+ 2. Enforcement responsibilities and process
27
+ 3. Consequences framework
28
+
29
+ {: .note }
30
+ Use HDI Code of Conduct email address as contact method.
25
31
 
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:
32
+ ## Setup
27
33
 
28
34
  ```bash
29
35
  way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
30
36
  ```
31
37
 
32
- You will need to enter a contact method, usually an email address.
38
+ ## Usage
33
39
 
34
- {: .note }
35
- We recommend that you use the HDI code of conduct email address as the contact method.
40
+ Command creates `CODE_OF_CONDUCT.md` in repository root.
41
+
42
+ **Post-setup:**
43
+
44
+ 1. Review enforcement guidelines with team
45
+ 2. Assign enforcement responsibilities
46
+ 3. Communicate adoption to contributors
47
+ 4. Link from README and CONTRIBUTING
48
+
49
+ **Enforcement process:**
50
+ Report → Review → Investigate → Apply consequence → Document
51
+
52
+ ## Enforcement
53
+
54
+ **Consequences:**
55
+
56
+ - **Warning:** First offense, minor issue
57
+ - **Temporary ban:** Sustained inappropriate behavior
58
+ - **Permanent ban:** Severe violations or repeat offenses
59
+
60
+ **Requirements:**
61
+
62
+ - Consistent enforcement by leadership
63
+ - Confidential handling, 5-day response
64
+ - Document incidents, annual review
65
+
66
+ ## Examples
67
+
68
+ **Acceptable:** Welcoming language, respect differing views, accept criticism, focus on community benefit
69
+
70
+ **Unacceptable:** Sexualized content, trolling/insults, harassment, publishing private info, unprofessional conduct
71
+
72
+ ## Resources
73
+
74
+ - [Contributor Covenant v2.1][covenant]
75
+ - [Enforcement Guidelines][enforcement]
76
+
77
+ [covenant]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
78
+ [enforcement]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines
@@ -3,7 +3,7 @@
3
3
  module WayOfWorking
4
4
  module CodeOfConduct
5
5
  module ContributorCovenant
6
- VERSION = '1.0.0'
6
+ VERSION = '1.0.1'
7
7
  end
8
8
  end
9
9
  end
@@ -12,7 +12,6 @@ rescue LoadError # rubocop:disable Lint/SuppressedException
12
12
  end
13
13
 
14
14
  loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::CodeOfConduct)
15
- loader.ignore("#{__dir__}/contributor_covenant/plugin.rb")
16
15
  loader.setup
17
16
 
18
17
  module WayOfWorking
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: way_of_working-code_of_conduct-contributor_covenant
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tim Gentry
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-01-24 00:00:00.000000000 Z
11
+ date: 2025-11-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: way_of_working
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '2.0'
19
+ version: 2.0.1
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '2.0'
26
+ version: 2.0.1
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: zeitwerk
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
89
89
  - !ruby/object:Gem::Version
90
90
  version: '0'
91
91
  requirements: []
92
- rubygems_version: 3.5.22
92
+ rubygems_version: 3.3.26
93
93
  signing_key:
94
94
  specification_version: 4
95
95
  summary: Way of Working plugin for the Contributor Covenant Code of Conduct