Skip to content

Commit f61d3e0

Browse files
committed
squash: add contributing docs
1 parent 27cb91d commit f61d3e0

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

.rubocop.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
plugins: rubocop-performance
22

33
AllCops:
4-
TargetRubyVersion: '3.2'
4+
TargetRubyVersion: 3.2
55
NewCops: enable
66
Exclude:
77
- Rakefile

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,35 @@ index e29acbfc..85622d25 100644
418418
(1/1) Stage this hunk [y,n,q,a,d,e,?]? y
419419
```
420420

421+
## Updating Ruby version requirements
422+
423+
To update the minimum Ruby version requirement across all gems in the repository, use the `bin/update-ruby-version` script:
424+
425+
```console
426+
# Update to Ruby 3.3 minimum
427+
bin/update-ruby-version 3.3
428+
429+
# Supports patch versions and pre-releases
430+
bin/update-ruby-version 3.2.0
431+
bin/update-ruby-version 3.4.0.alpha
432+
```
433+
434+
The script will:
435+
436+
1. Validate the version format
437+
2. Update `spec.required_ruby_version` in all gemspec files
438+
3. Show a summary of changes
439+
440+
After running the script:
441+
442+
1. Review changes with `git diff`
443+
2. Test against the new minimum Ruby version
444+
3. Update CI configurations in `.github/workflows`
445+
4. Update `.rubocop.yml` to set the `TargetRubyVersion`
446+
5. Remove any conditional logic handling Ruby verions in Apprisal files that is no longer needed
447+
6. Remove any conditional logic in test cases that are no longer needed
448+
7. Commit with a message like `chore: update minimum Ruby version to 3.3`
449+
421450
[cncf-cla]: https://identity.linuxfoundation.org/projects/cncf
422451
[github-draft]: https://github.blog/2019-02-14-introducing-draft-pull-requests/
423452
[kube-github-workflow-pr]: https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md#7-create-a-pull-request

0 commit comments

Comments
 (0)