Skip to content

Commit 6346bd3

Browse files
committed
Add upgrading guide
1 parent 282c7fb commit 6346bd3

4 files changed

Lines changed: 510 additions & 2 deletions

File tree

.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
--markup-provider=kramdown
22
--markup=markdown
3+
--files CHANGELOG.md,CONTRIBUTING.md,SECURITY.md,UPGRADING.md

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,20 @@ exist at the time of a major release, support for that Ruby version may be
208208
dropped.
209209

210210

211+
## Upgrading
212+
213+
See [UPGRADING.md] for a detailed migration guide between major versions.
214+
215+
216+
## Security
217+
218+
See [SECURITY.md] for reporting vulnerabilities.
219+
220+
211221
## Contributing to http.rb
212222

223+
See [CONTRIBUTING.md] for guidelines, or the quick version:
224+
213225
- Fork http.rb on GitHub
214226
- Make your changes
215227
- Ensure all tests pass (`bundle exec rake`)
@@ -243,6 +255,9 @@ See LICENSE.txt for further details.
243255

244256
[//]: # (links)
245257

258+
[contributing.md]: https://github.com/httprb/http/blob/main/CONTRIBUTING.md
246259
[documentation]: https://github.com/httprb/http/wiki
247-
[requests]: https://docs.python-requests.org/en/latest/
248260
[llhttp]: https://llhttp.org/
261+
[requests]: https://docs.python-requests.org/en/latest/
262+
[security.md]: https://github.com/httprb/http/blob/main/SECURITY.md
263+
[upgrading.md]: https://github.com/httprb/http/blob/main/UPGRADING.md

0 commit comments

Comments
 (0)