summaryrefslogtreecommitdiff
path: root/doc/contributing
AgeCommit message (Collapse)Author
2023-05-12Use Lrama LALR parser generator instead of Bisonv3_3_0_preview1Yuichiro Kaneko
https://bugs.ruby-lang.org/issues/19637 Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> Notes: Merged: https://github.com/ruby/ruby/pull/7798 Merged-By: yui-knk <spiketeika@gmail.com>
2023-05-10readline or libedit is no longer required to build rubyHiroshi SHIBATA
2023-05-09Fix broken link to maintainers pageJemma Issroff
Notes: Merged: https://github.com/ruby/ruby/pull/7792
2023-04-05Add BIN as an entry in the glossary (#7667)Adam Hess
I initially thought this macro is referencing binary, not basic instruction name Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2023-03-10Bump the required BASERUBY version to 2.5 (#7504)Takashi Kokubun
[Misc #16671] I'd like to bump it to 2.7 to use pattern matching in tool/mk_builtin_loader.rb. However, I experienced a few blockers. 2.5 seems like the closest version that is easy enough to use on CIs, so let me bump the version to it as an intermediate step for it. I want to use &. and <<~ in 2.3 too. Known blockers: * AppVeyor Visual Studio 2015 doesn't have Ruby 2.7. You'd need to bump the version to Visual Studio 2019. * GitHub Actions windows-2019 doesn't have Ruby 2.7 either. You can use ruby/setup-ruby, but configure doesn't seem to work with it. * For ruby/ruby-ci-imaage, bionic doesn't have Ruby 2.7. I tried using ruby-build to build Ruby 2.7 from package, but the build on its CI seems to somehow loop forever when I do that. So I gave it up for now. We might want to wait until bionic becomes EOL. Note: * AppVeyor Visual Studio 2015 has Ruby <= 2.6.3 https://www.appveyor.com/docs/windows-images-software/#ruby * GitHub Actions windows-2019 uses Ruby 2.5.9 https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2023-03-03[DOC] Add missing word to documentation_guide.mdEzra-Shimon Rosenfeld
Notes: Merged: https://github.com/ruby/ruby/pull/7414
2023-02-19Mention when it is appropriate to document aliases in call-seqJeremy Evans
2023-02-19[DOC] Change to handling of aliases (#7340)Burdette Lamar
Change to handling of aliases Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2023-02-09Add internals glossaryAaron Patterson
I started a glossary to help new contributors navigate the internals of CRuby, and I think we should maintain it in ruby/ruby Notes: Merged: https://github.com/ruby/ruby/pull/7280
2023-02-08[DOC] Refine/fix doc/contributing/building_ruby.md [ci skip]Nobuyoshi Nakada
* Separate dependencies for RubyGems * Add reasons of optional libraries * Add a note for gperf and fix the required version
2023-02-07Fix confusing "Benoit Daloze
2023-02-07Mentioned gmp at requirementsHiroshi SHIBATA
2023-02-07Added tarball instruction to building_ruby.mdHiroshi SHIBATA
2023-01-20OpenSSL, libyaml and zlib is always required to build. see test/test_extlibs.rbHiroshi SHIBATA
2023-01-20Added supported versions to OpenSSL and libyamlHiroshi SHIBATA
2023-01-20Added version policy of BASERUBYHiroshi SHIBATA
[Misc #16671]
2023-01-20Separate dependencies section from quick startHiroshi SHIBATA
2023-01-20fixed wrong version of baserubyHiroshi SHIBATA
2023-01-06[DOC] Mention `configure` options earlier, not after failureNobuyoshi Nakada
The command line arguments to `configure` are stored in `rbconfig.rb`. Usually these are just useless but harmless after the installation, however could affect unexpectedly when updating default gems. Notes: Merged: https://github.com/ruby/ruby/pull/7076
2023-01-06[DOC] Specify `shell` format to shell commandsNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/7076
2022-11-21YJIT: Lower the required Rust version from 1.58.1 to 1.58.0 (#6780)Takashi Kokubun
Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2022-11-10Update required Bison version in building_ruby.md [ci skip]yui-knk
See [Feature #19068] for the context. Notes: Merged: https://github.com/ruby/ruby/pull/6705
2022-11-08[doc] Clarify how to build OpenSSL on macOSMatt Valentine-House
Notes: Merged: https://github.com/ruby/ruby/pull/6692
2022-11-07[DOC] Properly number the list in building_ruby.mdPeter Zhu
2022-11-07[DOC] Improve building_ruby.mdPeter Zhu
2022-11-03Update configure command in building_ruby.mdPeter Zhu
Readers didn't realize that you can use --prefix with --disable-install-doc.
2022-10-27Update docs wrt YJIT limitations and building YJIT (#6641)Maxime Chevalier-Boisvert
* Update docs wrt YJIT limitations and building YJIT * Update building_ruby.md Fix relative link Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2022-10-24[DOC] Add note about method names (#6620)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-06Adapt doc guide to new GFM features (#6504)Burdette Lamar
* Adapt doc guide to new GFM features * Adapt doc guide to new GFM features Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-04[DOC] Adding remarks about HTML and tables (#6485)Burdette Lamar
* Adding remarks about HTML and tables Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-22[DOC] Addition to section 'Related Methods' (#6271)Burdette Lamar
Addition to section 'Related Methods': suggests adding differentiators to the names of related methods. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-02[DOC] Specify ways to run bootstrap testsPeter Zhu
Notes: Merged: https://github.com/ruby/ruby/pull/6194
2022-07-27[ci-skip]Document how to run an individual bootstrap testMatt Valentine-House
Notes: Merged: https://github.com/ruby/ruby/pull/6190
2022-07-12[DOC] Revisions for call-seq in doc guidelines (#6121)Burdette Lamar
Splits certain guidelines for singleton and instance method. Calls for instance method to not prefix anything (like RDoc itself for a Ruby-coded instance method); e.g.: count -> integer, not array.count,. <=> other -> integer or nil, not hash <=> other -> integer or nil. Groups previous guidelines into Arguments, Block, Return types, Aliases. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-06-06Fix a typo [ci skip]Kazuhiro NISHIYAMA
2022-05-30Add information from doc/hacking.md and doc/make_cheatsheet.md back i… (#5963)Jemma Issroff
Add information from doc/hacking.md and doc/make_cheatsheet.md back into contributing docs Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2022-05-19[DOC] Re-markup as MarkdownNobuyoshi Nakada
2022-05-18[DOC] Use `make gdb-ruby` and `make lldb-ruby` in ↵Kaíque Kandy Koga
doc/contributing/building_ruby.md Notes: Merged: https://github.com/ruby/ruby/pull/5908 Merged-By: nobu <nobu@ruby-lang.org>
2022-05-11Add a separate doc for contributing to stdlibs [ci skip]Stan Lo
co-authored-by: Peter Zhu <peter@peterzhu.ca> Notes: Merged: https://github.com/ruby/ruby/pull/5901
2022-05-11Improve documentation on contributing to RubyJemma Issroff
co-authored-by: Peter Zhu <peter@peterzhu.ca> co-authored-by: Stan Lo <stan001212@gmail.com> Notes: Merged: https://github.com/ruby/ruby/pull/5899
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-17 15:18:32 +0000