Skip to content

Commit 93e804c

Browse files
committed
📝 Improving documentation
1 parent 54d1a77 commit 93e804c

File tree

4 files changed

+96
-81
lines changed

4 files changed

+96
-81
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,21 @@
22

33
Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/oauth-xx/oauth][🚎src-main]. This project is
44
intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
5-
the [code of conduct][conduct].
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].
69

710
To submit a patch, please fork the project and create a patch with
811
tests. Once you're happy with it send a pull request and post a message to the
912
[google group][mailinglist] or on the [gitter chat][🏘chat].
1013

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+
1120
## Run tests
1221

1322
### Against Rails 6
@@ -17,22 +26,39 @@ BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install
1726
BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake
1827
```
1928

20-
2129
### Against Rails 7
2230

2331
```bash
2432
BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install
2533
BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake
2634
```
2735

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+
2851
## Contributors
2952

30-
See: [https://gitlab.com/oauth-xx/oauth/-/graphs/main][🚎contributors]
53+
[![Contributors][🖐contributors-img]][🖐contributors]
3154

3255
[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
3356

34-
[conduct]: https://gitlab.com/oauth-xx/oauth/-/blob/main/CODE_OF_CONDUCT.md
35-
[🚎contributors]: https://gitlab.com/oauth-xx/oauth/-/graphs/main
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
3660
[mailinglist]: http://groups.google.com/group/oauth-ruby
3761
[🚎src-main]: https://gitlab.com/oauth-xx/oauth/-/tree/main
38-
[🏘chat]: https://gitter.im/oauth-xx/oauth-ruby
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

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
The MIT License (MIT)
22

33
Copyright (c) 2007-2012, 2016-2017 Blaine Cook, Larry Halff, Pelle Braendgaard
4-
Copyright (c) 2020-2022 Peter Boling
4+
Copyright (c) 2020-2022 oauth-xx organization, https://gitlab.com/oauth-xx
55

66
Permission is hereby granted, free of charge, to any person obtaining a copy
77
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)