11## Contributing
22
3- Bug reports and pull requests are welcome on GitLab at [ https://gitlab.com/oauth-xx/oauth2 ] [ 🚎src-main ]
4- . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
3+ Bug reports and pull requests are welcome on GitLab at [ https://gitlab.com/oauth-xx/oauth2 ] [ 🚎src-main ] .
4+ This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
55the [ code of conduct] [ 🤝conduct ] .
66
7- To submit a patch, please fork the project and create a patch with tests.
8- Once you're happy with it send a pull request.
7+ To submit a patch, please fork the project, create a patch with tests, and send a pull request.
98
10- We [ ![ Keep A Changelog] [ 📗keep-changelog-img ]] [ 📗keep-changelog ] so if you make changes, remember to update it .
9+ Remember to [ ![ Keep A Changelog] [ 📗keep-changelog-img ]] [ 📗keep-changelog ] if you make changes.
1110
12- ## You can help !
11+ ## Help out !
1312
1413Take a look at the ` reek ` list which is the file called ` REEK ` and find something to improve.
1514
16- Simply follow these instructions:
15+ Follow these instructions:
1716
18171 . Fork the repository
19- 2 . Create your feature branch (` git checkout -b my-new-feature ` )
18+ 2 . Create a feature branch (` git checkout -b my-new-feature ` )
20193 . Make some fixes.
21- 4 . Commit your changes (` git commit -am 'Added some feature' ` )
20+ 4 . Commit changes (` git commit -am 'Added some feature' ` )
22215 . Push to the branch (` git push origin my-new-feature ` )
23226 . Make sure to add tests for it. This is important, so it doesn't break in a future release.
24237 . Create new Pull Request.
2524
2625## Appraisals
2726
2827From time to time the appraisal gemfiles in ` gemfiles/ ` will need to be updated.
29- They are created and updated with the commands:
3028
3129NOTE: We run on a [ fork] [ 🚎appraisal-fork ] of Appraisal.
3230
3331Please upvote the PR for ` eval_gemfile ` [ support] [ 🚎appraisal-eval-gemfile-pr ]
3432
33+ Create or update them with the commands:
34+
3535``` shell
3636BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
3737BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
3838bundle exec rake rubocop_gradual:autocorrect
3939```
4040
41- When adding an appraisal to CI check the [ runner tool cache] [ 🏃♂️runner-tool-cache ] to see which runner to use.
41+ When adding an appraisal to CI, check the [ runner tool cache] [ 🏃♂️runner-tool-cache ] to see which runner to use.
4242
4343## The Reek List
4444
@@ -74,8 +74,6 @@ bundle exec rake rubocop_gradual:autocorrect
7474
7575## Contributors
7676
77- Your picture could be here!
78-
7977[ ![ Contributors] [ 🖐contributors-img ]] [ 🖐contributors ]
8078
8179Made with [ contributors-img] [ 🖐contrib-rocks ] .
@@ -86,35 +84,35 @@ Also see GitLab Contributors: [https://gitlab.com/oauth-xx/oauth2/-/graphs/main]
8684
8785### One-time, Per-maintainer, Setup
8886
89- ** IMPORTANT** : If you want to sign the build you create ,
90- your public key for signing gems will need to be picked up by the line in the
87+ ** IMPORTANT** : To sign a build,
88+ a public key for signing gems will need to be picked up by the line in the
9189` gemspec ` defining the ` spec.cert_chain ` (check the relevant ENV variables there).
92- All releases to RubyGems.org will be signed.
90+ All releases to RubyGems.org are signed releases .
9391See: [ RubyGems Security Guide] [ 🔒️rubygems-security-guide ]
9492
95- NOTE: To build without signing the gem you must set ` SKIP_GEM_SIGNING ` to some value in your environment.
93+ NOTE: To build without signing the gem set ` SKIP_GEM_SIGNING ` to any value in the environment.
9694
9795### To release a new version:
9896
99971 . Run ` bin/setup && bin/rake ` as a "test, coverage, & linting" sanity check
100982 . Update the version number in ` version.rb ` , and ensure ` CHANGELOG.md ` reflects changes
101993 . Run ` bin/setup && bin/rake ` again as a secondary check, and to update ` Gemfile.lock `
1021004 . Run ` git commit -am "🔖 Prepare release v<VERSION>" ` to commit the changes
103- 5 . Run ` git push ` to trigger the final CI pipeline before release, & merge PRs
104- - NOTE: Remember to [ check the build] [ 🧪build ] !
101+ 5 . Run ` git push ` to trigger the final CI pipeline before release, and merge PRs
102+ - NOTE: Remember to [ check the build] [ 🧪build ] .
1051036 . Run ` export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME `
1061047 . Run ` git checkout $GIT_TRUNK_BRANCH_NAME `
107- 8 . Run ` git pull origin $GIT_TRUNK_BRANCH_NAME ` to ensure you will release the latest trunk code
105+ 8 . Run ` git pull origin $GIT_TRUNK_BRANCH_NAME ` to ensure latest trunk code
1081069 . Set ` SOURCE_DATE_EPOCH ` so ` rake build ` and ` rake release ` use same timestamp, and generate same checksums
109107 - Run ` export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH `
110108 - If the echo above has no output, then it didn't work.
111- - Note that you'll need the ` zsh/datetime ` module, if running ` zsh ` .
109+ - Note: ` zsh/datetime ` module is needed , if running ` zsh ` .
112110 - In older versions of ` bash ` you can use ` date +%s ` instead, i.e. ` export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH `
11311110 . Run ` bundle exec rake build `
11411211 . Run ` bin/gem_checksums ` (more context [ 1] [ 🔒️rubygems-checksums-pr ] , [ 2] [ 🔒️rubygems-guides-pr ] )
115113 to create SHA-256 and SHA-512 checksums. This functionality is provided by the ` stone_checksums `
116114 [ gem] [ 💎stone_checksums ] .
117- - Checksums will be committed automatically by the script but not pushed
115+ - The script automatically commits but does not push the checksums
11811612 . Run ` bundle exec rake release ` which will create a git tag for the version,
119117 push git commits and tags, and push the ` .gem ` file to [ rubygems.org] [ 💎rubygems ]
120118
0 commit comments