1
1
## Contributing
2
2
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
5
5
the [ code of conduct] [ 🤝conduct ] .
6
6
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.
9
8
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.
11
10
12
- ## You can help !
11
+ ## Help out !
13
12
14
13
Take a look at the ` reek ` list which is the file called ` REEK ` and find something to improve.
15
14
16
- Simply follow these instructions:
15
+ Follow these instructions:
17
16
18
17
1 . 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 ` )
20
19
3 . Make some fixes.
21
- 4 . Commit your changes (` git commit -am 'Added some feature' ` )
20
+ 4 . Commit changes (` git commit -am 'Added some feature' ` )
22
21
5 . Push to the branch (` git push origin my-new-feature ` )
23
22
6 . Make sure to add tests for it. This is important, so it doesn't break in a future release.
24
23
7 . Create new Pull Request.
25
24
26
25
## Appraisals
27
26
28
27
From time to time the appraisal gemfiles in ` gemfiles/ ` will need to be updated.
29
- They are created and updated with the commands:
30
28
31
29
NOTE: We run on a [ fork] [ 🚎appraisal-fork ] of Appraisal.
32
30
33
31
Please upvote the PR for ` eval_gemfile ` [ support] [ 🚎appraisal-eval-gemfile-pr ]
34
32
33
+ Create or update them with the commands:
34
+
35
35
``` shell
36
36
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
37
37
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
38
38
bundle exec rake rubocop_gradual:autocorrect
39
39
```
40
40
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.
42
42
43
43
## The Reek List
44
44
@@ -74,8 +74,6 @@ bundle exec rake rubocop_gradual:autocorrect
74
74
75
75
## Contributors
76
76
77
- Your picture could be here!
78
-
79
77
[ ![ Contributors] [ 🖐contributors-img ]] [ 🖐contributors ]
80
78
81
79
Made with [ contributors-img] [ 🖐contrib-rocks ] .
@@ -86,35 +84,35 @@ Also see GitLab Contributors: [https://gitlab.com/oauth-xx/oauth2/-/graphs/main]
86
84
87
85
### One-time, Per-maintainer, Setup
88
86
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
91
89
` 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 .
93
91
See: [ RubyGems Security Guide] [ 🔒️rubygems-security-guide ]
94
92
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.
96
94
97
95
### To release a new version:
98
96
99
97
1 . Run ` bin/setup && bin/rake ` as a "test, coverage, & linting" sanity check
100
98
2 . Update the version number in ` version.rb ` , and ensure ` CHANGELOG.md ` reflects changes
101
99
3 . Run ` bin/setup && bin/rake ` again as a secondary check, and to update ` Gemfile.lock `
102
100
4 . 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 ] .
105
103
6 . Run ` export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME `
106
104
7 . 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
108
106
9 . Set ` SOURCE_DATE_EPOCH ` so ` rake build ` and ` rake release ` use same timestamp, and generate same checksums
109
107
- Run ` export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH `
110
108
- 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 ` .
112
110
- In older versions of ` bash ` you can use ` date +%s ` instead, i.e. ` export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH `
113
111
10 . Run ` bundle exec rake build `
114
112
11 . Run ` bin/gem_checksums ` (more context [ 1] [ 🔒️rubygems-checksums-pr ] , [ 2] [ 🔒️rubygems-guides-pr ] )
115
113
to create SHA-256 and SHA-512 checksums. This functionality is provided by the ` stone_checksums `
116
114
[ 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
118
116
12 . Run ` bundle exec rake release ` which will create a git tag for the version,
119
117
push git commits and tags, and push the ` .gem ` file to [ rubygems.org] [ 💎rubygems ]
120
118
0 commit comments