|
1 |
| -## Contributing |
2 |
| - |
3 |
| -Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/oauth-xx/oauth][πsrc-main]. This project is |
4 |
| -intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to |
5 |
| -the [code of conduct][πcode-conduct]. |
6 |
| - |
7 |
| -Everyone interacting in the OAuth::TTY project's codebases, issue trackers, chat |
8 |
| -rooms and mailing lists is expected to follow the [code of conduct][πcode-conduct]. |
9 |
| - |
10 |
| -To submit a patch, please fork the project and create a patch with |
11 |
| -tests. Once you're happy with it send a pull request and post a message to the |
12 |
| -[google group][mailinglist] or on the [gitter chat][πchat]. |
13 |
| - |
14 |
| -## Create a Patch |
15 |
| - |
16 |
| -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. |
17 |
| - |
18 |
| -To install this gem onto your local machine, run `bundle exec rake install`. |
19 |
| - |
20 |
| -## Run tests |
21 |
| - |
22 |
| -### Against Rails 6 |
23 |
| - |
24 |
| -```bash |
25 |
| -BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install |
26 |
| -BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake |
27 |
| -``` |
28 |
| - |
29 |
| -### Against Rails 7 |
30 |
| - |
31 |
| -```bash |
32 |
| -BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install |
33 |
| -BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake |
34 |
| -``` |
35 |
| - |
36 |
| -## Release |
37 |
| - |
38 |
| -To release a new version: |
39 |
| - |
40 |
| -1. update the version number in `version.rb` |
41 |
| -2. run `bundle exec rake build:checksum` |
42 |
| -3. move the built gem to project root |
43 |
| -4. run `bin/checksum` to create the missing SHA256 checksum |
44 |
| -5. move the built gem back to `pkg/` |
45 |
| -6. run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). |
46 |
| - |
47 |
| -NOTE: You will need to have a public key in `certs/`, and list your cert in the |
48 |
| -`gemspec`, in order to sign the new release. |
49 |
| -See: [RubyGems Security Guide][rubygems-security-guide] |
50 |
| - |
51 |
| -## Contributors |
52 |
| - |
53 |
| -[![Contributors][πcontributors-img]][πcontributors] |
54 |
| - |
55 |
| -[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage) |
56 |
| - |
57 |
| -[πcode-conduct]: https://gitlab.com/oauth-xx/oauth/-/blob/main/CODE_OF_CONDUCT.md |
58 |
| -[πcontributors]: https://gitlab.com/oauth-xx/oauth/-/graphs/main |
59 |
| -[πcontributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby |
60 |
| -[mailinglist]: http://groups.google.com/group/oauth-ruby |
61 |
| -[πsrc-main]: https://gitlab.com/oauth-xx/oauth/-/tree/main |
62 |
| -[πchat]: https://gitter.im/oauth-xx/oauth-ruby |
63 |
| -[rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems |
64 |
| -[rubygems]: https://rubygems.org |
| 1 | +#<--rubocop/md-->## Contributing |
| 2 | +#<--rubocop/md--> |
| 3 | +#<--rubocop/md-->Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/oauth-xx/oauth][πsrc-main]. This project is |
| 4 | +#<--rubocop/md-->intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to |
| 5 | +#<--rubocop/md-->the [code of conduct][πcode-conduct]. |
| 6 | +#<--rubocop/md--> |
| 7 | +#<--rubocop/md-->Everyone interacting in the OAuth::TTY project's codebases, issue trackers, chat |
| 8 | +#<--rubocop/md-->rooms and mailing lists is expected to follow the [code of conduct][πcode-conduct]. |
| 9 | +#<--rubocop/md--> |
| 10 | +#<--rubocop/md-->To submit a patch, please fork the project and create a patch with |
| 11 | +#<--rubocop/md-->tests. Once you're happy with it send a pull request and post a message to the |
| 12 | +#<--rubocop/md-->[google group][mailinglist] or on the [gitter chat][πchat]. |
| 13 | +#<--rubocop/md--> |
| 14 | +#<--rubocop/md-->## Create a Patch |
| 15 | +#<--rubocop/md--> |
| 16 | +#<--rubocop/md-->After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. |
| 17 | +#<--rubocop/md--> |
| 18 | +#<--rubocop/md-->To install this gem onto your local machine, run `bundle exec rake install`. |
| 19 | +#<--rubocop/md--> |
| 20 | +#<--rubocop/md-->## Run tests |
| 21 | +#<--rubocop/md--> |
| 22 | +#<--rubocop/md-->### Against Rails 6 |
| 23 | +#<--rubocop/md--> |
| 24 | +#<--rubocop/md-->```bash |
| 25 | +#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install |
| 26 | +#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake |
| 27 | +#<--rubocop/md-->``` |
| 28 | +#<--rubocop/md--> |
| 29 | +#<--rubocop/md-->### Against Rails 7 |
| 30 | +#<--rubocop/md--> |
| 31 | +#<--rubocop/md-->```bash |
| 32 | +#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install |
| 33 | +#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake |
| 34 | +#<--rubocop/md-->``` |
| 35 | +#<--rubocop/md--> |
| 36 | +#<--rubocop/md-->## Release |
| 37 | +#<--rubocop/md--> |
| 38 | +#<--rubocop/md-->To release a new version: |
| 39 | +#<--rubocop/md--> |
| 40 | +#<--rubocop/md-->1. update the version number in `version.rb` |
| 41 | +#<--rubocop/md-->2. run `bundle exec rake build:checksum` |
| 42 | +#<--rubocop/md-->3. move the built gem to project root |
| 43 | +#<--rubocop/md-->4. run `bin/checksum` to create the missing SHA256 checksum |
| 44 | +#<--rubocop/md-->5. move the built gem back to `pkg/` |
| 45 | +#<--rubocop/md-->6. run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). |
| 46 | +#<--rubocop/md--> |
| 47 | +#<--rubocop/md-->NOTE: You will need to have a public key in `certs/`, and list your cert in the |
| 48 | +#<--rubocop/md-->`gemspec`, in order to sign the new release. |
| 49 | +#<--rubocop/md-->See: [RubyGems Security Guide][rubygems-security-guide] |
| 50 | +#<--rubocop/md--> |
| 51 | +#<--rubocop/md-->## Contributors |
| 52 | +#<--rubocop/md--> |
| 53 | +#<--rubocop/md-->[![Contributors][πcontributors-img]][πcontributors] |
| 54 | +#<--rubocop/md--> |
| 55 | +#<--rubocop/md-->[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage) |
| 56 | +#<--rubocop/md--> |
| 57 | +#<--rubocop/md-->[πcode-conduct]: https://gitlab.com/oauth-xx/oauth/-/blob/main/CODE_OF_CONDUCT.md |
| 58 | +#<--rubocop/md-->[πcontributors]: https://gitlab.com/oauth-xx/oauth/-/graphs/main |
| 59 | +#<--rubocop/md-->[πcontributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby |
| 60 | +#<--rubocop/md-->[mailinglist]: http://groups.google.com/group/oauth-ruby |
| 61 | +#<--rubocop/md-->[πsrc-main]: https://gitlab.com/oauth-xx/oauth/-/tree/main |
| 62 | +#<--rubocop/md-->[πchat]: https://gitter.im/oauth-xx/oauth-ruby |
| 63 | +#<--rubocop/md-->[rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems |
| 64 | +#<--rubocop/md-->[rubygems]: https://rubygems.org |
0 commit comments